{
"Array" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "indexOf",
]
},
"Date" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "add",
]
},
"Function" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "createCallback",
]
},
"Number" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "constrain",
]
},
"Roo" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "addBehaviors",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "itemCls",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : ""
},
{
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
]
},
"Roo.ComponentMgr" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "get",
]
},
"Roo.CompositeElement" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "add",
]
},
"Roo.CompositeElementLite" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "add",
{
"name" : "region",
"type" : "String",
- "desc" : [
- "(center",
+ "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "",
+ "optvals" : [
+ "center",
"north",
"south",
"east",
- "west)"
- ],
- "memberOf" : ""
+ "west"
+ ]
},
{
"name" : "resizeEl",
"memberOf" : ""
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "getContextMenu",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
]
},
"Roo.DialogManager" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "bringToFront",
"memberOf" : "Roo.util.Observable"
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "addEvents",
]
},
"Roo.DomHelper" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "append",
]
},
"Roo.DomQuery" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "compile",
"memberOf" : "Roo.Template"
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "append",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "ignoreNoChange",
]
},
"Roo.Element" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "addClass",
]
},
"Roo.EventManager" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "addListener",
]
},
"Roo.EventObject" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "getCharCode",
"memberOf" : ""
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "fadeIn",
{
"name" : "region",
"type" : "String",
- "desc" : [
- "(center",
+ "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.ContentPanel",
+ "optvals" : [
+ "center",
"north",
"south",
"east",
- "west)"
- ],
- "memberOf" : "Roo.ContentPanel"
+ "west"
+ ]
},
{
"name" : "resizeEl",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
]
},
"Roo.KeyMap" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "addBinding",
"memberOf" : ""
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "disable",
"memberOf" : ""
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "addClass",
{
"name" : "tabPosition",
"type" : "String",
- "desc" : [
- "(top",
- "bottom)"
- ],
- "memberOf" : ""
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf" : "",
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
"name" : "title",
"memberOf" : "Roo"
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "disable",
"memberOf" : "Roo.Template"
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "add",
{
"name" : "region",
"type" : "String",
- "desc" : [
- "(center",
+ "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.ContentPanel",
+ "optvals" : [
+ "center",
"north",
"south",
"east",
- "west)"
- ],
- "memberOf" : "Roo.ContentPanel"
+ "west"
+ ]
},
{
"name" : "resizeEl",
"type" : "Number",
"desc" : "The number of records to display per page (defaults to 20)",
"memberOf" : ""
+ },
+ {
+ "name" : "text",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "Roo.Toolbar"
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "add",
]
},
"Roo.QuickTips" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "disable",
"memberOf" : ""
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "hide",
]
},
"Roo.SplitBar.AbsoluteLayoutAdapter" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "getElementSize",
]
},
"Roo.SplitBar.BasicLayoutAdapter" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "getElementSize",
{
"name" : "tabPosition",
"type" : "String",
- "desc" : [
- "(top",
- "bottom)"
- ],
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf" : "Roo.LayoutRegion",
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
"name" : "title",
"memberOf" : ""
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "append",
"type" : "Array",
"desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
"memberOf" : "Roo"
+ },
+ {
+ "name" : "text",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : ""
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "add",
]
},
"Roo.Toolbar.Fill" : {
- "props" : [
- ],
- "events" : [
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires when the button is rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Toolbar.Item"
- }
- ],
- "methods" : [
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Removes and destroys this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item"
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item"
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item"
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item"
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Get this item's HTML Element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item"
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item"
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function for boolean show/hide.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item"
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Shows this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Toolbar.Item"
- }
- ]
- },
- "Roo.Toolbar.Item" : {
- "props" : [
- ],
- "events" : [
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires when the button is rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- }
- ],
- "methods" : [
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Removes and destroys this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enables this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Get this item's HTML Element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function for boolean show/hide.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Shows this item.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.Toolbar.Separator" : {
- "props" : [
+ "props" : [],
+ "events" : [
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Toolbar.Item"
+ }
],
+ "methods" : [
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Removes and destroys this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disables this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enables this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item"
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Get this item's HTML Element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item"
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function for boolean show/hide.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Shows this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Toolbar.Item"
+ }
+ ]
+ },
+ "Roo.Toolbar.Item" : {
+ "props" : [],
+ "events" : [
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the button is rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Removes and destroys this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disables this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enables this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Get this item's HTML Element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function for boolean show/hide.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Shows this item.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.Toolbar.Separator" : {
+ "props" : [],
"events" : [
{
"name" : "render",
]
},
"Roo.Toolbar.Spacer" : {
- "props" : [
- ],
+ "props" : [],
"events" : [
{
"name" : "render",
},
"Roo.Toolbar.TextItem" : {
"props" : [
+ {
+ "name" : "text",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "Roo.Toolbar"
+ }
],
"events" : [
{
{
"name" : "region",
"type" : "String",
- "desc" : [
- "(center",
+ "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.ContentPanel",
+ "optvals" : [
+ "center",
"north",
"south",
"east",
- "west)"
- ],
- "memberOf" : "Roo.ContentPanel"
+ "west"
+ ]
},
{
"name" : "resizeEl",
]
},
"Roo.UpdateManager.BasicRenderer" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "render",
]
},
"Roo.UpdateManager.defaults" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.View" : {
"props" : [
]
},
"Roo.XComponent.event.events" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.XTemplate" : {
"props" : [
"memberOf" : "Roo.Template"
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "append",
]
},
"Roo.bootstrap" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.bootstrap.Alert" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : [
- "( success",
+ "desc" : ")",
+ "memberOf" : "",
+ "optvals" : [
+ "success",
"info",
"warning",
- "danger )"
- ],
- "memberOf" : ""
+ "danger"
+ ]
},
{
"name" : "xattr",
},
"Roo.bootstrap.BezierSignature" : {
"props" : [
+ {
+ "name" : "Add",
+ "type" : "integer",
+ "desc" : "the next point only if the previous one is farther than x pixels. Defaults to 5.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "Callback",
+ "type" : "function",
+ "desc" : "when stroke begin.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "Color",
+ "type" : "string",
+ "desc" : "used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to \"black\".",
+ "memberOf" : ""
+ },
+ {
+ "name" : "Draw",
+ "type" : "integer",
+ "desc" : "the next point at most once per every x milliseconds. Set it to 0 to turn off throttling. Defaults to 16.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "Maximum",
+ "type" : "float",
+ "desc" : "width of a line. Defaults to 2.5.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "Minimum",
+ "type" : "float",
+ "desc" : "width of a line. Defaults to 0.5.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "Radius",
+ "type" : "float|function",
+ "desc" : "of a single dot.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "Weight",
+ "type" : "float",
+ "desc" : "used to modify new velocity based on the previous velocity. Defaults to 0.7.",
+ "memberOf" : ""
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "canvas",
+ "type" : "int",
+ "desc" : "height",
+ "memberOf" : ""
+ },
{
"name" : "cls",
"type" : "String",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "badge_weight",
"type" : "String",
- "desc" : [
- "(default",
+ "desc" : ") default (same as button)",
+ "memberOf" : "",
+ "optvals" : [
+ "default",
"primary",
"secondary",
"success",
"info",
"warning",
"danger",
- "link )"
- ],
- "memberOf" : ""
+ "link"
+ ]
},
{
"name" : "can_build_overlaid",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
{
"name" : "pressed",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "default null - if the button ahs active state",
"memberOf" : ""
},
{
{
"name" : "size",
"type" : "String",
- "desc" : [
- "( lg",
+ "desc" : "s)",
+ "memberOf" : "",
+ "optvals" : [
+ "lg",
"sm",
- "xs)"
- ],
- "memberOf" : ""
+ "xs"
+ ]
},
{
"name" : "style",
{
"name" : "tag",
"type" : "String",
- "desc" : [
- "( a",
+ "desc" : "t)",
+ "memberOf" : "",
+ "optvals" : [
+ "a",
"input",
- "submit)"
- ],
- "memberOf" : ""
+ "submit"
+ ]
},
{
"name" : "target",
"type" : "String",
- "desc" : "target for a href. (_self|_blank|_parent|_top| other)",
- "memberOf" : ""
+ "desc" : "r) target for a href.",
+ "memberOf" : "",
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top",
+ "other"
+ ]
},
{
"name" : "theme",
"type" : "String",
- "desc" : [
- "(default",
- "glow)"
- ],
- "memberOf" : ""
+ "desc" : "w)",
+ "memberOf" : "",
+ "optvals" : [
+ "default",
+ "glow"
+ ]
},
{
"name" : "toggle",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : [
- "(default",
+ "desc" : ") default",
+ "memberOf" : "",
+ "optvals" : [
+ "default",
"primary",
"secondary",
"success",
"info",
"warning",
"danger",
- "link )"
- ],
- "memberOf" : ""
+ "link"
+ ]
},
{
"name" : "xattr",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
]
},
- "Roo.bootstrap.CheckBox" : {
+ "Roo.bootstrap.Card" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "boxLabel",
- "type" : "String",
- "desc" : "The text that appears beside the checkbox",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "initnal the element",
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "display",
+ "type" : "String",
+ "desc" : "x)",
+ "memberOf" : "",
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
+ },
+ {
+ "name" : "display_lg",
+ "type" : "String",
+ "desc" : "x)",
+ "memberOf" : "",
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
+ },
+ {
+ "name" : "display_sm",
+ "type" : "String",
+ "desc" : "x)",
+ "memberOf" : "",
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
+ },
+ {
+ "name" : "display_xl",
+ "type" : "String",
+ "desc" : "x)",
+ "memberOf" : "",
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
+ },
+ {
+ "name" : "display_xs",
+ "type" : "String",
+ "desc" : "x)",
+ "memberOf" : "",
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
},
{
- "name" : "focusClass",
+ "name" : "footer",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "",
+ "memberOf" : ""
},
{
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "header",
+ "type" : "String|Object",
+ "desc" : "",
+ "memberOf" : ""
},
{
- "name" : "groupId",
+ "name" : "header_image",
"type" : "String",
- "desc" : "the checkbox group id // normal just use for checkbox",
+ "desc" : "src url of image.",
"memberOf" : ""
},
{
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "header_size",
+ "type" : "Number",
+ "desc" : "5) H1 or H2 etc.. 0 indicates default",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "inline",
- "type" : "Boolean",
- "desc" : "inline the element (default false)",
+ "name" : "html",
+ "type" : "String|Boolean",
+ "desc" : "-- html contents - or just use children.. use false to hide it..",
"memberOf" : ""
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "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" : "inputValue",
+ "name" : "margin",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value when checked.",
- "memberOf" : ""
+ "desc" : "o)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "invalidClass",
+ "name" : "margin_bottom",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "o)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "invalidFeedbackIcon",
+ "name" : "margin_left",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "o)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "invalidText",
+ "name" : "margin_right",
"type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "o)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "labelAlign",
+ "name" : "margin_top",
"type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "desc" : "o)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "maskRe",
+ "name" : "margin_x",
"type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "o)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "maxLengthText",
+ "name" : "margin_y",
"type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "o)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "minLengthText",
+ "name" : "padding",
"type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "5)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
- "name" : "name",
+ "name" : "padding_bottom",
"type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "5)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "padding_left",
+ "type" : "String",
+ "desc" : "5)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
- "name" : "regexText",
+ "name" : "padding_right",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "5)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "padding_top",
+ "type" : "String",
+ "desc" : "5)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "padding_x",
+ "type" : "String",
+ "desc" : "5)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "padding_y",
+ "type" : "String",
+ "desc" : "5)",
+ "memberOf" : "",
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tooltip",
+ "name" : "subtitle",
"type" : "String",
- "desc" : "label tooltip",
+ "desc" : "",
"memberOf" : ""
},
{
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
+ "name" : "title",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "",
+ "memberOf" : ""
},
{
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valueOff",
- "type" : "String",
- "desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : ""
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : [
- "(primary",
+ "desc" : "k)",
+ "memberOf" : "",
+ "optvals" : [
+ "primary",
"warning",
"info",
"danger",
- "success)"
- ],
- "memberOf" : ""
+ "secondary",
+ "success",
+ "light",
+ "dark"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the element is checked or unchecked.",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "childrenrendered",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when the element is click.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "enable",
+ "name" : "drop",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "When a element a card is dropped",
+ "sig" : "function (_self, n, dd, e, data)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "focus",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.Component"
},
{
"name" : "hide",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "render",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "specialkey",
+ "name" : "rotate",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "When a element a card is rotate",
+ "sig" : "function (_self, n, rotate)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "valid",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a CheckBox Group based on the group ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "getChildContainer",
"type" : "function",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "getEl",
+ "name" : "getDropPoint",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Decide whether to drop above or below a View node.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "getId",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component"
},
{
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getValue",
+ "name" : "getTargetFromEvent",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n whole Element becomes the target, and this causes the drop gesture to append.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : ""
},
{
"name" : "getVisibilityEl",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a CheckBox Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "releaseCapture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.Column" : {
+ "Roo.bootstrap.CardFooter" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "alert",
- "type" : "String",
- "desc" : [
- "(success",
- "info",
- "warning",
- "danger)"
- ],
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "fa",
+ "name" : "hideMode",
"type" : "String",
- "desc" : [
- "(ban",
- "check",
- "...)"
- ],
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "fasize",
- "type" : "Number",
- "desc" : [
- "(1",
- "2",
- "....)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of column.",
- "memberOf" : ""
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : [
- "(info-sign",
- "check",
- "...)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : ""
- },
- {
- "name" : "lgoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : ""
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : ""
- },
- {
- "name" : "mdoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : ""
- },
- {
- "name" : "smoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : ""
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "tag of the element",
+ "memberOf" : "Roo.bootstrap.Element"
+ },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : ""
- },
- {
- "name" : "xsoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : ""
}
],
"events" : [
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Element"
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
- "Roo.bootstrap.ComboBox" : {
+ "Roo.bootstrap.CardHeader" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : ""
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : ""
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
- },
- {
- "name" : "append",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : ""
- },
- {
- "name" : "autoFocus",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : ""
- },
- {
- "name" : "btnPosition",
- "type" : "String",
- "desc" : "set the position of the trigger button (left | right) default right",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : [
- "(search",
- "calendar)"
- ],
- "memberOf" : "Roo.bootstrap.TriggerField"
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : ""
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "editable",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : ""
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "emptyResultText",
- "type" : "Boolean",
- "desc" : "only for touch device",
- "memberOf" : ""
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "emptyTitle",
+ "name" : "tag",
"type" : "String",
- "desc" : "default ''",
- "memberOf" : ""
+ "desc" : "tag of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
- "name" : "fieldLabel",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : ""
- },
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
{
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : ""
+ "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"
},
{
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : ""
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : ""
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : ""
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : ""
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.TriggerField"
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : ""
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ }
+ ],
+ "methods" : [
{
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : ""
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : ""
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : ""
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : ""
+ "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"
},
{
- "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>",
+ "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"
},
{
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : ""
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : ""
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : ""
- },
- {
- "name" : "mobileTouchView",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "mobile_restrict_height",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "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"
},
{
- "name" : "modalTitle",
- "type" : "String",
- "desc" : "The title of the dialog that pops up on mobile views.",
- "memberOf" : ""
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : ""
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "multiple",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : ""
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : ""
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : ""
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.bootstrap.CardImageTop" : {
+ "props" : [
{
- "name" : "regexText",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "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" : "removable",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.TriggerField"
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "resizable",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : ""
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "selectOnFocus",
+ "name" : "clickable",
"type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : ""
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "selectedClass",
+ "name" : "cls",
"type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : ""
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : ""
- },
- {
- "name" : "showToggleBtn",
- "type" : "Boolean",
- "desc" : "show toggle button or not (true|false) default true",
- "memberOf" : ""
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
- "name" : "size",
+ "name" : "container_method",
"type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "specialFilter",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tickable",
- "type" : "Boolean",
- "desc" : "ComboBox with tickable selections (true|false), default false",
- "memberOf" : ""
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : ""
- },
- {
- "name" : "tooltip",
+ "name" : "dataId",
"type" : "string",
- "desc" : "Text for the tooltip",
+ "desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : ""
- },
- {
- "name" : "triggerAction",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : ""
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "triggerClass",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "triggerList",
- "type" : "Boolean",
- "desc" : "trigger show the list or not (true|false) default true",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "triggerText",
+ "name" : "html",
"type" : "String",
- "desc" : "multiple combobox trigger button text default 'Select'",
- "memberOf" : ""
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : ""
+ "name" : "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" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : ""
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "useNativeIOS",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "validClass",
+ "name" : "style",
"type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "validFeedbackIcon",
+ "name" : "tag",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "tag of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : ""
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "afterremove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforerender",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforeshow",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "childrenrendered",
"type" : "function",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "collapse",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "destroy",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "enable",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "show",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "name" : "specialfilter",
- "type" : "function",
- "desc" : "Fires when specialfilter",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "tick",
- "type" : "function",
- "desc" : "Fires when tick the element",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "touchviewdisplay",
- "type" : "function",
- "desc" : "Fires when touch view require special display (default is using displayField)",
- "sig" : "function (combo, cfg)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "capture",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "clearInvalid",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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"
- },
- {
- "name" : "disable",
+ "name" : "disable",
"type" : "function",
"desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "fireEvent",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.Component" : {
+ "Roo.bootstrap.CardUploader" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text for badge",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "badge_weight",
+ "type" : "String",
+ "desc" : ") default (same as button)",
+ "memberOf" : "Roo.bootstrap.Button",
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link"
+ ]
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "disableClass",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "default false;",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
+ "memberOf" : ""
+ },
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "depricated - use fa",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "empty or href",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "html",
+ "type" : "Array",
+ "desc" : "The button text.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "images",
+ "type" : "Array",
+ "desc" : "an array of ?? Img objects ??? when loading existing files..",
+ "memberOf" : ""
+ },
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "dark themed version",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "isClose",
+ "type" : "Boolean",
+ "desc" : "default false;",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "listeners",
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "offtext",
+ "type" : "String",
+ "desc" : "text for off slidy toggle state",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "ontext",
+ "type" : "String",
+ "desc" : "text for on slidy toggle state",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "outline",
+ "type" : "Boolean",
+ "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "pressed",
+ "type" : "Boolean",
+ "desc" : "default null - if the button ahs active state",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "default true (stop click event triggering the URL if it's a link.)",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "removeClass",
+ "type" : "Boolean",
+ "desc" : "remove the standard class..",
+ "memberOf" : "Roo.bootstrap.Button"
+ },
+ {
+ "name" : "size",
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.Button",
+ "optvals" : [
+ "lg",
+ "sm",
+ "xs"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Button",
+ "optvals" : [
+ "a",
+ "input",
+ "submit"
+ ]
+ },
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "r) target for a href.",
+ "memberOf" : "Roo.bootstrap.Button",
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top",
+ "other"
+ ]
+ },
+ {
+ "name" : "theme",
+ "type" : "String",
+ "desc" : "w)",
+ "memberOf" : "Roo.bootstrap.Button",
+ "optvals" : [
+ "default",
+ "glow"
+ ]
+ },
+ {
+ "name" : "toggle",
+ "type" : "Boolean",
+ "desc" : "is it a slidy toggle button",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : ""
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : ") default",
+ "memberOf" : "Roo.bootstrap.Button",
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
}
],
"events" : [
"type" : "function",
"desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a butotn is pressed",
+ "sig" : "function (btn, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "destroy",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "toggle",
+ "type" : "function",
+ "desc" : "After the button has been toggles",
+ "sig" : "function (btn, e, pressed)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button"
}
],
"methods" : [
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Disable this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Enables this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "fireEvent",
"desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "getEl",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getText",
+ "type" : "function",
+ "desc" : "get the text of the first selected button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button"
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "hasListener",
"desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "initEvents",
"desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "isActive",
+ "type" : "function",
+ "desc" : "get the current active state",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "isVisible",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setActive",
+ "type" : "function",
+ "desc" : "sets the active state on/off,",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setText",
+ "type" : "function",
+ "desc" : "set the text of the first selected button",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "setVisible",
"desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "toggleActive",
+ "type" : "function",
+ "desc" : "toggles the current active state",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "tooltipEl",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "un",
}
]
},
- "Roo.bootstrap.Container" : {
+ "Roo.bootstrap.CheckBox" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "alert",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
"type" : "String",
- "desc" : [
- "(success",
- "info",
- "warning",
- "danger)"
- ],
- "memberOf" : ""
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "The text that appears beside the checkbox",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "clickable",
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "checked",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "initnal the element",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "expandable",
+ "name" : "disableKeyFilter",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "expanded",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "fa",
- "type" : "String",
- "desc" : "font awesome icon",
- "memberOf" : ""
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "footer",
+ "name" : "focusClass",
"type" : "String",
- "desc" : "content of footer (for panel)",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "header",
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "groupId",
"type" : "String",
- "desc" : "content of header (for panel)",
+ "desc" : "the checkbox group id // normal just use for checkbox",
"memberOf" : ""
},
{
- "name" : "hidden",
+ "name" : "hasFeedback",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of element",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "icon",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : [
- "(info-sign",
- "check",
- "...)"
- ],
- "memberOf" : ""
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "jumbotron",
+ "name" : "inline",
"type" : "Boolean",
- "desc" : "is it a jumbotron element",
+ "desc" : "inline the element (default false)",
"memberOf" : ""
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "inputValue",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value when checked.",
+ "memberOf" : ""
},
{
- "name" : "panel",
+ "name" : "invalidClass",
"type" : "String",
- "desc" : [
- "(default",
- "primary",
- "success",
- "info",
- "warning",
- "danger)"
- ],
- "memberOf" : ""
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "rheader",
+ "name" : "invalidFeedbackIcon",
"type" : "String",
- "desc" : "contet on the right of header",
- "memberOf" : ""
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "sticky",
+ "name" : "invalidText",
"type" : "String",
- "desc" : [
- "(footer",
- "wrap",
- "push)"
- ],
- "memberOf" : ""
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tag",
+ "name" : "tooltip",
"type" : "String",
- "desc" : [
- "(header",
- "aside",
- "section)"
- ],
+ "desc" : "label tooltip",
"memberOf" : ""
},
{
- "name" : "tooltip",
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "value",
"type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "valueOff",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value when unchecked.",
+ "memberOf" : ""
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "well",
+ "name" : "vtype",
"type" : "String",
- "desc" : [
- "(lg",
- "sm",
- "md)"
- ],
- "memberOf" : ""
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "s) The text that appears beside the checkbox",
+ "memberOf" : "",
+ "optvals" : [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"memberOf" : "Roo.Component"
},
{
- "name" : "childrenrendered",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "click",
+ "name" : "change",
"type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "check",
+ "type" : "function",
+ "desc" : "Fires when the element is checked or unchecked.",
+ "sig" : "function (_self, checked)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "collapse",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "After the panel has been collapsed",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when the element is click.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
"memberOf" : "Roo.Component"
},
{
- "name" : "expand",
+ "name" : "focus",
"type" : "function",
- "desc" : "After the panel has been expand",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "hide",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "render",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a CheckBox Group based on the group ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
+ },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a CheckBox Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
+ },
{
"name" : "releaseCapture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.DateField" : {
+ "Roo.bootstrap.Column" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
+ "name" : "alert",
"type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "r) type alert (changes background / border...)",
+ "memberOf" : "",
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "altFormats",
- "type" : "String",
- "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
- "memberOf" : ""
- },
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "calendarWeeks",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "daysOfWeekDisabled",
- "type" : "Object",
- "desc" : "default empty",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "fa",
+ "type" : "String",
+ "desc" : ".) font awesome icon",
+ "memberOf" : "",
+ "optvals" : [
+ "ban",
+ "check",
+ "..."
+ ]
},
{
- "name" : "endDate",
+ "name" : "fasize",
"type" : "Number",
- "desc" : "default Infinity",
- "memberOf" : ""
+ "desc" : ".) font awsome size",
+ "memberOf" : "",
+ "optvals" : [
+ "1",
+ "2",
+ "...."
+ ]
},
{
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "e) hide the element",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "focusClass",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "format",
+ "name" : "html",
"type" : "String",
- "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "desc" : "content of column.",
"memberOf" : ""
},
{
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "icon",
+ "type" : "String",
+ "desc" : ".) glyphicon name",
+ "memberOf" : "",
+ "optvals" : [
+ "info-sign",
+ "check",
+ "..."
+ ]
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyboardNavigation",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
+ "name" : "lg",
"type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "language",
- "type" : "String",
- "desc" : "default en",
+ "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
"memberOf" : ""
},
{
- "name" : "lg",
+ "name" : "lgoff",
"type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "md",
"type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
+ "memberOf" : ""
},
{
- "name" : "minLength",
+ "name" : "mdoff",
"type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minViewMode",
- "type" : "String",
- "desc" : "default empty, (months|years)",
+ "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
"memberOf" : ""
},
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "singleMode",
- "type" : "Boolean",
- "desc" : "default false (true | false)",
- "memberOf" : ""
- },
- {
- "name" : "size",
"type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "sm",
"type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : ""
},
{
- "name" : "startDate",
+ "name" : "smoff",
"type" : "Number",
- "desc" : "default -Infinity",
+ "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
"memberOf" : ""
},
{
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "todayBtn",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
- },
- {
- "name" : "todayHighlight",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "viewMode",
- "type" : "String",
- "desc" : "default empty, (months|years)",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "weekStart",
- "type" : "Number",
- "desc" : "default 0",
- "memberOf" : ""
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
{
"name" : "xs",
"type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf" : ""
+ },
+ {
+ "name" : "xsoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf" : ""
}
],
"events" : [
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires when before select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforeshow",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "childrenrendered",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.DateSplitField" : {
+ "Roo.bootstrap.ComboBox" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
- "name" : "cls",
+ "name" : "allQuery",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : ""
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "dayAllowBlank",
+ "name" : "alwaysQuery",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "Disable caching of results, and always send query",
"memberOf" : ""
},
{
- "name" : "dayFormat",
- "type" : "string",
- "desc" : "default 'd'",
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "default true",
"memberOf" : ""
},
{
- "name" : "dayPlaceholder",
- "type" : "string",
- "desc" : "",
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
"memberOf" : ""
},
{
- "name" : "disableClass",
+ "name" : "autoFocus",
+ "type" : "Boolean",
+ "desc" : "e) auto focus the first item, default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "autocomplete",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "fieldLabel",
+ "name" : "before",
"type" : "string",
- "desc" : "- the label associated",
- "memberOf" : ""
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hideMode",
+ "name" : "blankText",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
"memberOf" : ""
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label (0-12)",
+ "name" : "btnPosition",
+ "type" : "String",
+ "desc" : "set the position of the trigger button (left | right) default right",
"memberOf" : ""
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "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" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "monthAllowBlank",
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disableClear",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "Disable showing of clear button.",
"memberOf" : ""
},
{
- "name" : "monthFormat",
- "type" : "string",
- "desc" : "default 'm'",
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
"memberOf" : ""
},
{
- "name" : "monthPlaceholder",
- "type" : "string",
- "desc" : "",
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
"memberOf" : ""
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "emptyResultText",
+ "type" : "Boolean",
+ "desc" : "only for touch device",
+ "memberOf" : ""
},
{
- "name" : "style",
+ "name" : "emptyTitle",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "default ''",
+ "memberOf" : ""
},
{
- "name" : "tooltip",
+ "name" : "fieldLabel",
"type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "yearAllowBlank",
+ "name" : "forceSelection",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
"memberOf" : ""
},
{
- "name" : "yearFormat",
- "type" : "string",
- "desc" : "default 'Y'",
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
"memberOf" : ""
},
{
- "name" : "yearPlaceholder",
- "type" : "string",
+ "name" : "growMax",
+ "type" : "Number",
"desc" : "",
"memberOf" : ""
- }
- ],
- "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"
},
{
- "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"
- },
- {
- "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"
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : ""
},
{
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : ""
},
{
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "days",
- "type" : "function",
- "desc" : "getting the data of days",
- "sig" : "function (_self, days)\n{\n\n}",
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
"memberOf" : ""
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.TriggerField"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
"memberOf" : ""
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
- "name" : "years",
- "type" : "function",
- "desc" : "getting the data of years",
- "sig" : "function (_self, years)\n{\n\n}",
- "memberOf" : ""
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "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"
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : ""
},
{
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : ""
},
{
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : ""
},
{
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
},
{
- "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"
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : ""
},
{
- "name" : "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"
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : ""
},
{
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : ""
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : ""
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : ""
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "mobileTouchView",
+ "type" : "Boolean",
+ "desc" : "e) show mobile touch view when using a mobile default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "mobile_restrict_height",
+ "type" : "Boolean",
+ "desc" : "e) restrict height for touch view",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "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"
+ "name" : "modalTitle",
+ "type" : "String",
+ "desc" : "The title of the dialog that pops up on mobile views.",
+ "memberOf" : ""
},
{
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : ""
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "multiple",
+ "type" : "Boolean",
+ "desc" : "e) ComboBobArray, default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.bootstrap.DocumentManager" : {
- "props" : [
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : ""
+ },
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "allowDomMove",
+ "name" : "preventMark",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "boxes",
+ "name" : "queryDelay",
"type" : "Number",
- "desc" : "number of boxes, 0 is no limit.. default 0",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
"memberOf" : ""
},
{
- "name" : "can_build_overlaid",
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "readOnly",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "editable",
+ "name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
"memberOf" : ""
},
{
- "name" : "fieldLabel",
+ "name" : "selectedClass",
"type" : "String",
- "desc" : "",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
"memberOf" : ""
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : ""
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : [
- "(left",
- "top)"
- ],
+ "name" : "showToggleBtn",
+ "type" : "Boolean",
+ "desc" : "show toggle button or not (true|false) default true",
"memberOf" : ""
},
{
- "name" : "labelWidth",
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
"type" : "Number",
- "desc" : "default 4",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "specialFilter",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
"memberOf" : ""
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tickable",
+ "type" : "Boolean",
+ "desc" : "ComboBox with tickable selections (true|false), default false",
"memberOf" : ""
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
"memberOf" : ""
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
"memberOf" : ""
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
"memberOf" : ""
},
{
- "name" : "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" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.TriggerField"
},
{
- "name" : "method",
+ "name" : "triggerList",
+ "type" : "Boolean",
+ "desc" : "trigger show the list or not (true|false) default true",
+ "memberOf" : ""
+ },
+ {
+ "name" : "triggerText",
"type" : "String",
- "desc" : "default POST",
+ "desc" : "multiple combobox trigger button text default 'Select'",
"memberOf" : ""
},
{
- "name" : "multiple",
+ "name" : "typeAhead",
"type" : "Boolean",
- "desc" : "multiple upload default true",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
"memberOf" : ""
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "typeAheadDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : ""
},
{
- "name" : "paramName",
+ "name" : "useNativeIOS",
+ "type" : "Boolean",
+ "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "validClass",
"type" : "String",
- "desc" : "default 'imageUpload'",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
"memberOf" : ""
},
{
- "name" : "style",
+ "name" : "validFeedbackIcon",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "thumbSize",
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationDelay",
"type" : "Number",
- "desc" : "default 300",
- "memberOf" : ""
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "toolTipName",
- "type" : "String",
- "desc" : "default 'filename'",
- "memberOf" : ""
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tooltip",
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "value",
"type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "url",
+ "name" : "valueField",
"type" : "String",
- "desc" : "action url",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
"memberOf" : ""
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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.Input"
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
{
- "name" : "afterupload",
+ "name" : "add",
"type" : "function",
- "desc" : "Fire when xhr load exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "afterremove",
+ "type" : "function",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : ""
},
{
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforequery",
+ "type" : "function",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforerender",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "beforeselectfile",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Fire before select file",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
"memberOf" : ""
},
{
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "childrenrendered",
"type" : "function",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "click",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Fire after click the image",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : ""
},
{
{
"name" : "edit",
"type" : "function",
- "desc" : "Fire when upload a image and editable set to true",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "exception",
+ "name" : "expand",
"type" : "function",
- "desc" : "Fire when xhr load exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : ""
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "hide",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "initial",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fire when initial the DocumentManager",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "inspect",
+ "name" : "keyup",
"type" : "function",
- "desc" : "inspect selected file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "prepare",
+ "name" : "remove",
"type" : "function",
- "desc" : "prepare the form data",
- "sig" : "function (_self, formData)\n{\n\n}",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "previewrendered",
+ "name" : "render",
"type" : "function",
- "desc" : "Fire when preview rendered",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "process",
+ "name" : "select",
"type" : "function",
- "desc" : "Fire before process file",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "refresh",
+ "name" : "show",
"type" : "function",
- "desc" : "Fire after refresh the file",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "specialfilter",
+ "type" : "function",
+ "desc" : "Fires when specialfilter",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "remove",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Fire when remove the file",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "tick",
+ "type" : "function",
+ "desc" : "Fires when tick the element",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "render",
+ "name" : "touchviewdisplay",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Fires when touch view require special display (default is using displayField)",
+ "sig" : "function (combo, cfg)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "show",
+ "name" : "valid",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
{
"name" : "capture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "fireEvent",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
{
"name" : "purgeListeners",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "setDisabled",
+ "name" : "reset",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "setVisibilityEl",
+ "name" : "select",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
- "name" : "setVisible",
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "setVisible",
"type" : "function",
"desc" : "Convenience function to hide or show this component by boolean.",
"sig" : "(visible)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.DocumentSlider" : {
+ "Roo.bootstrap.Component" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "disableClass",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
}
],
"events" : [
"type" : "function",
"desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fire after click",
- "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "initial",
- "type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "render",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "name" : "update",
- "type" : "function",
- "desc" : "Fire after update",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
}
],
"methods" : [
"desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "getEl",
"desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "hasListener",
"desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "initEvents",
"desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "isVisible",
"desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "setVisible",
"desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "tooltipEl",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "un",
}
]
},
- "Roo.bootstrap.DocumentViewer" : {
+ "Roo.bootstrap.Container" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "alert",
+ "type" : "String",
+ "desc" : "r) type alert (changes background / border...)",
+ "memberOf" : "",
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expandable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "expanded",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "font awesome icon",
+ "memberOf" : ""
+ },
+ {
+ "name" : "footer",
+ "type" : "String",
+ "desc" : "content of footer (for panel)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "header",
+ "type" : "String",
+ "desc" : "content of header (for panel)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "e) hide the element",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of element",
+ "memberOf" : ""
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : ".) glyphicon name",
+ "memberOf" : "",
+ "optvals" : [
+ "info-sign",
+ "check",
+ "..."
+ ]
+ },
+ {
+ "name" : "jumbotron",
+ "type" : "Boolean",
+ "desc" : "is it a jumbotron element",
+ "memberOf" : ""
},
{
"name" : "listeners",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "showDownload",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "name" : "panel",
+ "type" : "String",
+ "desc" : "r) render as panel - type - primary/success.....",
+ "memberOf" : "",
+ "optvals" : [
+ "default",
+ "primary",
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
- "name" : "showTrash",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "rheader",
+ "type" : "String",
+ "desc" : "contet on the right of header",
"memberOf" : ""
},
+ {
+ "name" : "sticky",
+ "type" : "String",
+ "desc" : "h) block to use as footer or body- needs css-bootstrap/sticky-footer.css",
+ "memberOf" : "",
+ "optvals" : [
+ "footer",
+ "wrap",
+ "push"
+ ]
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "n) type of HTML tag.",
+ "memberOf" : "",
+ "optvals" : [
+ "header",
+ "aside",
+ "section"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "well",
+ "type" : "String",
+ "desc" : "d) a well, large, small or medium.",
+ "memberOf" : "",
+ "optvals" : [
+ "lg",
+ "sm",
+ "md"
+ ]
},
{
"name" : "xattr",
{
"name" : "click",
"type" : "function",
- "desc" : "Fire after click",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "After the panel has been collapsed",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "download",
- "type" : "function",
- "desc" : "Fire after download button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "enable",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "hide",
+ "name" : "expand",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "After the panel has been expand",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "initial",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fire after initEvent",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "render",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "name" : "trash",
- "type" : "function",
- "desc" : "Fire after trash button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
}
],
"methods" : [
}
]
},
- "Roo.bootstrap.Element" : {
+ "Roo.bootstrap.DateField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "altFormats",
+ "type" : "String",
+ "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
+ "memberOf" : ""
+ },
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "calendarWeeks",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "clickable",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "daysOfWeekDisabled",
+ "type" : "Object",
+ "desc" : "default empty",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "contents of the element",
- "memberOf" : ""
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "endDate",
+ "type" : "Number",
+ "desc" : "default Infinity",
+ "memberOf" : ""
},
{
- "name" : "name",
+ "name" : "fieldLabel",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "tag",
+ "name" : "format",
"type" : "String",
- "desc" : "tag of the element",
+ "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
"memberOf" : ""
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "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"
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "click",
- "type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
+ "name" : "keyboardNavigation",
+ "type" : "Boolean",
+ "desc" : "default true",
"memberOf" : ""
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "language",
+ "type" : "String",
+ "desc" : "default en",
+ "memberOf" : ""
},
{
- "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"
- },
- {
- "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"
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : 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"
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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"
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "minViewMode",
+ "type" : "String",
+ "desc" : "default empty, (months|years)",
+ "memberOf" : ""
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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"
+ "name" : "singleMode",
+ "type" : "Boolean",
+ "desc" : "default false (true | false)",
+ "memberOf" : ""
},
{
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "startDate",
+ "type" : "Number",
+ "desc" : "default -Infinity",
+ "memberOf" : ""
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.bootstrap.FieldLabel" : {
- "props" : [
- {
- "name" : "actionMode",
+ "name" : "style",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "allowBlank",
+ "name" : "todayBtn",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "default false",
"memberOf" : ""
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "can_build_overlaid",
+ "name" : "todayHighlight",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "class of the element",
+ "desc" : "default false",
"memberOf" : ""
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "dataId",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "cutomer id",
+ "desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "hideMode",
+ "name" : "validClass",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "html",
+ "name" : "validFeedbackIcon",
"type" : "String",
- "desc" : "contents of the element",
- "memberOf" : ""
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "iconTooltip",
- "type" : "String",
- "desc" : "default \"This field is required\"",
- "memberOf" : ""
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : ""
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - BS4 uses is-invalid",
- "memberOf" : ""
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "name",
+ "name" : "value",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "tag of the element default label",
- "memberOf" : ""
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "target",
+ "name" : "viewMode",
"type" : "String",
- "desc" : "label target",
+ "desc" : "default empty, (months|years)",
"memberOf" : ""
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "validClass",
+ "name" : "vtype",
"type" : "String",
- "desc" : "DEPRICATED - BS4 uses is-valid",
- "memberOf" : ""
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "weekStart",
+ "type" : "Number",
+ "desc" : "default 0",
+ "memberOf" : ""
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires when before select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforeshow",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "childrenrendered",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "hide",
"type" : "function",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "render",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Fires when this field show.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "valid",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a FieldLabel Group based on the target",
- "sig" : "(target)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "isVisible",
"type" : "function",
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "markValid",
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a FieldLabel Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "releaseCapture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- }
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ }
]
},
- "Roo.bootstrap.Form" : {
+ "Roo.bootstrap.DateSplitField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "left | right - for navbars",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "dayAllowBlank",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "dayFormat",
+ "type" : "string",
+ "desc" : "default 'd'",
+ "memberOf" : ""
+ },
+ {
+ "name" : "dayPlaceholder",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "errorMask",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "fileUpload",
- "type" : "Boolean",
- "desc" : "Set to true if this form is a file upload.",
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
"memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "top | left (default top)",
+ "desc" : "t)",
+ "memberOf" : "",
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label (0-12)",
"memberOf" : ""
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : ""
},
{
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "load mask when submit (default true)",
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : ""
},
{
- "name" : "maskBody",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : ""
},
{
- "name" : "maskOffset",
+ "name" : "labelxs",
"type" : "Number",
- "desc" : "Default 100",
+ "desc" : "set the width of label (1-12)",
"memberOf" : ""
},
{
- "name" : "method",
- "type" : "String",
- "desc" : "GET | POST (default POST)",
+ "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" : "monthAllowBlank",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "monthFormat",
+ "type" : "string",
+ "desc" : "default 'm'",
+ "memberOf" : ""
+ },
+ {
+ "name" : "monthPlaceholder",
+ "type" : "string",
+ "desc" : "",
"memberOf" : ""
},
{
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "url",
- "type" : "String",
- "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
+ },
{
- "name" : "actioncomplete",
- "type" : "function",
- "desc" : "Fires when an action is completed.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : ""
+ "name" : "yearAllowBlank",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "actionfailed",
- "type" : "function",
- "desc" : "Fires when an action fails.",
- "sig" : "function (_self, action)\n{\n\n}",
+ "name" : "yearFormat",
+ "type" : "string",
+ "desc" : "default 'Y'",
"memberOf" : ""
},
{
- "name" : "beforeaction",
- "type" : "function",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "sig" : "function (_self, action)\n{\n\n}",
+ "name" : "yearPlaceholder",
+ "type" : "string",
+ "desc" : "",
"memberOf" : ""
- },
+ }
+ ],
+ "events" : [
{
"name" : "beforedestroy",
"type" : "function",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "clientvalidation",
+ "name" : "days",
"type" : "function",
- "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
- "sig" : "function (_self, valid)\n{\n\n}",
+ "desc" : "getting the data of days",
+ "sig" : "function (_self, days)\n{\n\n}",
"memberOf" : ""
},
{
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "render",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "years",
+ "type" : "function",
+ "desc" : "getting the data of years",
+ "sig" : "function (_self, years)\n{\n\n}",
+ "memberOf" : ""
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clears all invalid messages in this form.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "doAction",
- "type" : "function",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
- "sig" : "(actionName, options)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "findField",
- "type" : "function",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "fireEvent",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getFieldValues",
- "type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "getId",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getValues",
- "type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
- "sig" : "(asString)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if any fields in this form have changed since their original load.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns true if client-side validation on the form is successful.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "isVisible",
"type" : "function",
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark fields in this form invalid in bulk.",
- "sig" : "(errors)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
"memberOf" : ""
},
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets this form.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setValues",
- "type" : "function",
- "desc" : "Set values for fields in this form in bulk.",
- "sig" : "(values)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.Graph" : {
+ "Roo.bootstrap.DocumentManager" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "boxes",
+ "type" : "Number",
+ "desc" : "number of boxes, 0 is no limit.. default 0",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "g_height",
- "type" : "number",
- "desc" : "height of the chart (respected by all elements in the set)",
- "memberOf" : ""
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "e) allow edit when upload a image default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "g_r",
- "type" : "number",
- "desc" : "radius (pie)",
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "",
"memberOf" : ""
},
{
- "name" : "g_width",
- "type" : "number",
- "desc" : "width of the chart (respected by all elements in the set)",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "p) default left",
+ "memberOf" : "",
+ "optvals" : [
+ "left",
+ "top"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "default 4",
"memberOf" : ""
},
{
- "name" : "g_x",
- "type" : "number",
- "desc" : "coodinator | centre x (pie)",
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : ""
},
{
- "name" : "g_y",
- "type" : "number",
- "desc" : "coodinator | centre y (pie)",
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : ""
},
{
- "name" : "graphtype",
- "type" : "String",
- "desc" : "bar | vbar | pie",
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
"memberOf" : ""
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "default POST",
+ "memberOf" : ""
+ },
+ {
+ "name" : "multiple",
+ "type" : "Boolean",
+ "desc" : "multiple upload default true",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "paramName",
+ "type" : "String",
+ "desc" : "default 'imageUpload'",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "title",
- "type" : "Object",
- "desc" : "The title of the chart\n \n -{Array} values\n -opts (object) options for the chart \n o {\n o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n o vgutter (number)\n o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n o stacked (boolean) whether or not to tread values as in a stacked bar chart\n o to\n o stretch (boolean)\n o }\n -opts (object) options for the pie\n o{\n o cut\n o startAngle (number)\n o endAngle (number)\n }",
+ "name" : "thumbSize",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : ""
+ },
+ {
+ "name" : "toolTipName",
+ "type" : "String",
+ "desc" : "default 'filename'",
"memberOf" : ""
},
{
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "action url",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
],
"events" : [
+ {
+ "name" : "afterupload",
+ "type" : "function",
+ "desc" : "Fire when xhr load exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforeselectfile",
+ "type" : "function",
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforeshow",
"type" : "function",
{
"name" : "click",
"type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fire after click the image",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : ""
},
{
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fire when upload a image and editable set to true",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "enable",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "exception",
+ "type" : "function",
+ "desc" : "Fire when xhr load exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "initial",
+ "type" : "function",
+ "desc" : "Fire when initial the DocumentManager",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "inspect",
+ "type" : "function",
+ "desc" : "inspect selected file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "prepare",
+ "type" : "function",
+ "desc" : "prepare the form data",
+ "sig" : "function (_self, formData)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "previewrendered",
+ "type" : "function",
+ "desc" : "Fire when preview rendered",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "process",
+ "type" : "function",
+ "desc" : "Fire before process file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Fire after refresh the file",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fire when remove the file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "render",
"type" : "function",
}
]
},
- "Roo.bootstrap.Header" : {
+ "Roo.bootstrap.DocumentSlider" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of header",
- "memberOf" : ""
- },
- {
- "name" : "level",
- "type" : "Number",
- "desc" : [
- "(1",
- "2",
- "3",
- "4",
- "5",
- "6)"
- ],
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fire after click",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "initial",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "render",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "update",
+ "type" : "function",
+ "desc" : "Fire after update",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
}
],
"methods" : [
}
]
},
- "Roo.bootstrap.HtmlEditor" : {
+ "Roo.bootstrap.DocumentViewer" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "buttons",
- "type" : "Array",
- "desc" : "Array of toolbar's buttons. - defaults to empty",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "cols",
- "type" : "Number",
- "desc" : "Specifies the visible width of a text area",
- "memberOf" : "Roo.bootstrap.TextArea"
- },
{
"name" : "container_method",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "fieldLabel",
+ "name" : "name",
"type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "forceFeedback",
+ "name" : "showDownload",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) show download button (default true)",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "hasFeedback",
+ "name" : "showTrash",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) show trash button (default true)",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "(in pixels)",
- "memberOf" : ""
- },
- {
- "name" : "hideMode",
+ "name" : "style",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "html",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "text",
- "memberOf" : "Roo.bootstrap.TextArea"
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
{
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fire after click",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "download",
+ "type" : "function",
+ "desc" : "Fire after download button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "initial",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "trash",
+ "type" : "function",
+ "desc" : "Fire after trash button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ }
+ ],
+ "methods" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "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"
},
{
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "resizable",
- "type" : "String",
- "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "resize",
- "type" : "string",
- "desc" : [
- "(none",
- "both",
- "horizontal",
- "vertical",
- "inherit",
- "initial)"
- ],
- "memberOf" : "Roo.bootstrap.TextArea"
+ "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"
},
{
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : "Roo.bootstrap.TextArea"
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
+ "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"
},
{
- "name" : "stylesheets",
- "type" : "Array",
- "desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : ""
+ "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"
},
{
- "name" : "toolbars",
- "type" : "Array",
- "desc" : "Array of toolbars. - defaults to just the Standard one",
- "memberOf" : ""
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "validFeedbackIcon",
+ "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"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.bootstrap.DropTarget" : {
+ "props" : [
+ {
+ "name" : "actionMode",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "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" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "value",
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element"
+ },
+ {
+ "name" : "container_method",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "vtype",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "(in pixels)",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.Element"
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "dropable name",
"memberOf" : ""
},
{
- "name" : "wrap",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "tag of the element",
+ "memberOf" : "Roo.bootstrap.Element"
+ },
+ {
+ "name" : "tooltip",
"type" : "string",
- "desc" : [
- "(soft",
- "hard)"
- ],
- "memberOf" : "Roo.bootstrap.TextArea"
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "autosave",
- "type" : "function",
- "desc" : "Auto save the htmlEditor value as a file into Events",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforepush",
- "type" : "function",
- "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforerender",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforesync",
- "type" : "function",
- "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "childrenrendered",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "editmodechange",
- "type" : "function",
- "desc" : "Fires when the editor switches edit modes",
- "sig" : "function (_self, sourceEdit)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "editorevent",
- "type" : "function",
- "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "enable",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "firstfocus",
- "type" : "function",
- "desc" : "Fires when on first focus - needed by toolbars..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "initialize",
- "type" : "function",
- "desc" : "Fires when the editor is fully initialized (including the iframe)",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "push",
- "type" : "function",
- "desc" : "Fires when the iframe editor is updated with content from the textarea.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "savedpreview",
- "type" : "function",
- "desc" : "preview the saved version of htmlEditor",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "show",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "sync",
- "type" : "function",
- "desc" : "Fires when the textarea is updated with content from the editor iframe.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea"
- },
- {
- "name" : "createToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
- "sig" : "(editor)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real textarea element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setVisibilityEl",
+ "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"
},
- {
- "name" : "toggleSourceEdit",
- "type" : "function",
- "desc" : "Toggles the editor between standard and source edit mode.",
- "sig" : "(sourceEdit)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "tooltipEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.Img" : {
+ "Roo.bootstrap.Element" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "alt",
- "type" : "String",
- "desc" : "image alternative text",
- "memberOf" : ""
- },
- {
- "name" : "border",
- "type" : "String",
- "desc" : "rounded | circle | thumbnail",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "class of the element",
+ "memberOf" : ""
},
{
"name" : "container_method",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "a tag href",
- "memberOf" : ""
- },
- {
- "name" : "imgResponsive",
- "type" : "Boolean",
- "desc" : "false | true",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "lgUrl",
+ "name" : "html",
"type" : "String",
- "desc" : "lg image source",
+ "desc" : "contents of the element",
"memberOf" : ""
},
{
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "mdUrl",
- "type" : "String",
- "desc" : "md image source",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "smUrl",
- "type" : "String",
- "desc" : "sm image source",
- "memberOf" : ""
- },
- {
- "name" : "src",
- "type" : "String",
- "desc" : "image source",
- "memberOf" : ""
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "target",
+ "name" : "tag",
"type" : "String",
- "desc" : [
- "(_self",
- "_blank",
- "_parent",
- "_top)"
- ],
+ "desc" : "tag of the element",
"memberOf" : ""
},
{
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xsUrl",
- "type" : "String",
- "desc" : "xs image source",
- "memberOf" : ""
}
],
"events" : [
{
"name" : "click",
"type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : ""
},
{
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setSrc",
- "type" : "function",
- "desc" : "Sets the url of the image - used to update it",
- "sig" : "(url)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.Input" : {
+ "Roo.bootstrap.FieldLabel" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : ""
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : ""
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : ""
- },
{
"name" : "allowBlank",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : ""
+ "desc" : "e) target allowBlank default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : ""
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : ""
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "class of the element",
+ "memberOf" : ""
},
{
"name" : "container_method",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : ""
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : ""
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : ""
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "invalidClass",
+ "name" : "html",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "desc" : "contents of the element",
"memberOf" : ""
},
{
- "name" : "invalidFeedbackIcon",
+ "name" : "iconTooltip",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "desc" : "default \"This field is required\"",
"memberOf" : ""
},
{
- "name" : "invalidText",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : ""
+ "desc" : "t) default left",
+ "memberOf" : "",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "labelAlign",
+ "name" : "invalidClass",
"type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : ""
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
+ "desc" : "DEPRICATED - BS4 uses is-invalid",
"memberOf" : ""
},
{
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : ""
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : ""
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : ""
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : ""
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : ""
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : ""
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : ""
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : ""
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "regexText",
+ "name" : "style",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : ""
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "tag of the element default label",
"memberOf" : ""
},
{
- "name" : "style",
+ "name" : "target",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "label target",
+ "memberOf" : ""
},
{
"name" : "tooltip",
{
"name" : "validClass",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : ""
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : ""
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : ""
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : ""
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : ""
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : ""
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
+ "desc" : "DEPRICATED - BS4 uses is-valid",
"memberOf" : ""
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : ""
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : ""
}
],
"events" : [
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "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" : ""
- },
{
"name" : "childrenrendered",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self, msg)\n{\n\n}",
"memberOf" : ""
},
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "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" : ""
- },
{
"name" : "valid",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a FieldLabel Group based on the target",
+ "sig" : "(target)",
+ "static" : true,
+ "memberOf" : ""
+ },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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" : ""
- },
- {
- "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" : ""
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a FieldLabel Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
+ },
{
"name" : "releaseCapture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "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" : ""
- },
{
"name" : "setDisabled",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "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)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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" : ""
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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.LayoutMasonry" : {
+ "Roo.bootstrap.Form" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "left | right - for navbars",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "alternativePadWidth",
- "type" : "Number",
- "desc" : "padding below box..",
- "memberOf" : ""
- },
- {
- "name" : "boxHeight",
- "type" : "Number",
- "desc" : "- 0 for square, or fix it at a certian height",
- "memberOf" : ""
- },
- {
- "name" : "boxWidth",
- "type" : "Number",
- "desc" : "width of the columns",
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "gutter",
- "type" : "Number",
- "desc" : "gutter width..",
+ "name" : "errorMask",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "fileUpload",
+ "type" : "Boolean",
+ "desc" : "Set to true if this form is a file upload.",
"memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "isAutoInitial",
- "type" : "Boolean",
- "desc" : "defalut true",
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "top | left (default top)",
"memberOf" : ""
},
{
- "name" : "isHorizontal",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "loadMask",
"type" : "Boolean",
- "desc" : "defalut false",
+ "desc" : "load mask when submit (default true)",
"memberOf" : ""
},
{
- "name" : "isLayoutInstant",
+ "name" : "maskBody",
"type" : "Boolean",
- "desc" : "= no animation?",
+ "desc" : "",
"memberOf" : ""
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "maskOffset",
+ "type" : "Number",
+ "desc" : "Default 100",
+ "memberOf" : ""
},
{
- "name" : "maxCols",
- "type" : "Number",
- "desc" : "maximum number of columns",
+ "name" : "method",
+ "type" : "String",
+ "desc" : "GET | POST (default POST)",
"memberOf" : ""
},
{
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "padWidth",
- "type" : "Number",
- "desc" : "padding below box..",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
],
"events" : [
+ {
+ "name" : "actioncomplete",
+ "type" : "function",
+ "desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "actionfailed",
+ "type" : "function",
+ "desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "beforeaction",
+ "type" : "function",
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "clientvalidation",
+ "type" : "function",
+ "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
+ "sig" : "function (_self, valid)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "layout",
- "type" : "function",
- "desc" : "Fire after layout the items",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "render",
"type" : "function",
}
],
"methods" : [
- {
- "name" : "_processVerticalLayoutQueue",
- "type" : "function",
- "desc" : "Sets position of item in DOM",
- "sig" : "(item, x, y, isInstant)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "addBrick",
- "type" : "function",
- "desc" : "adds a Masonry Brick",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "addEvents",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "clearAll",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "clear all the Masonry Brick",
+ "desc" : "Clears all invalid messages in this form.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "doAction",
+ "type" : "function",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "findField",
+ "type" : "function",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "fireEvent",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Masonry Layout based on the masonry layout ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getFieldValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "getId",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if any fields in this form have changed since their original load.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns true if client-side validation on the form is successful.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Masonry Brick",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Masonry Layout",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "releaseCapture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "removeBrick",
- "type" : "function",
- "desc" : "remove a Masonry Brick",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "removeListener",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setValues",
+ "type" : "function",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.LayoutMasonryAuto" : {
+ "Roo.bootstrap.Graph" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "columnWidth",
- "type" : "Number",
- "desc" : "width of the columns",
- "memberOf" : ""
- },
{
"name" : "container_method",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "g_height",
+ "type" : "number",
+ "desc" : "height of the chart (respected by all elements in the set)",
+ "memberOf" : ""
},
{
- "name" : "isAutoInitial",
- "type" : "Boolean",
- "desc" : "defalut true",
+ "name" : "g_r",
+ "type" : "number",
+ "desc" : "radius (pie)",
"memberOf" : ""
},
{
- "name" : "isFitWidth",
- "type" : "Boolean",
- "desc" : "- resize the width..",
+ "name" : "g_width",
+ "type" : "number",
+ "desc" : "width of the chart (respected by all elements in the set)",
"memberOf" : ""
},
{
- "name" : "isLayoutInstant",
- "type" : "Boolean",
- "desc" : "= no animation?",
+ "name" : "g_x",
+ "type" : "number",
+ "desc" : "coodinator | centre x (pie)",
"memberOf" : ""
},
{
- "name" : "isOriginLeft",
- "type" : "Boolean",
- "desc" : "= left align?",
+ "name" : "g_y",
+ "type" : "number",
+ "desc" : "coodinator | centre y (pie)",
"memberOf" : ""
},
{
- "name" : "isOriginTop",
- "type" : "Boolean",
- "desc" : "= top align?",
+ "name" : "graphtype",
+ "type" : "String",
+ "desc" : "bar | vbar | pie",
"memberOf" : ""
},
{
- "name" : "isResizingContainer",
- "type" : "Boolean",
- "desc" : "= not sure if this is used..",
- "memberOf" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "maxCols",
- "type" : "Number",
- "desc" : "maximum number of columns",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "padHeight",
- "type" : "Number",
- "desc" : "padding below box..",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "title",
+ "type" : "Object",
+ "desc" : "The title of the chart\n \n -{Array} values\n -opts (object) options for the chart \n o {\n o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n o vgutter (number)\n o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n o stacked (boolean) whether or not to tread values as in a stacked bar chart\n o to\n o stretch (boolean)\n o }\n -opts (object) options for the pie\n o{\n o cut\n o startAngle (number)\n o endAngle (number)\n }",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
}
],
"methods" : [
- {
- "name" : "_getColGroup",
- "type" : "function",
- "desc" : "",
- "sig" : "(colSpan)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "_postLayout",
- "type" : "function",
- "desc" : "Any logic you want to do after each layout,\ni.e. size the container",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "_processLayoutQueue",
- "type" : "function",
- "desc" : "Sets position of item in DOM",
- "sig" : "(item, x, y, isInstant)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "addEvents",
"type" : "function",
}
]
},
- "Roo.bootstrap.Link" : {
+ "Roo.bootstrap.Header" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "alt",
- "type" : "String",
- "desc" : "image alternative text",
- "memberOf" : ""
- },
- {
- "name" : "anchor",
- "type" : "String",
- "desc" : "name for the anchor link",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- favicon",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "href",
+ "name" : "html",
"type" : "String",
- "desc" : "a tag href",
+ "desc" : "content of header",
"memberOf" : ""
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "the content of the link.",
- "memberOf" : ""
+ "name" : "level",
+ "type" : "Number",
+ "desc" : "6) default 1",
+ "memberOf" : "",
+ "optvals" : [
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "6"
+ ]
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "target",
- "type" : "String",
- "desc" : [
- "(_self",
- "_blank",
- "_parent",
- "_top)"
- ],
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- "Roo.bootstrap.LocationPicker" : {
+ "Roo.bootstrap.HtmlEditor" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "Array of toolbar's buttons. - defaults to empty",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "cols",
+ "type" : "Number",
+ "desc" : "Specifies the visible width of a text area",
+ "memberOf" : "Roo.bootstrap.TextArea"
+ },
{
"name" : "container_method",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableDoubleClickZoom",
+ "name" : "disableKeyFilter",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "draggable",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "enableAutocomplete",
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "enableReverseGeocode",
+ "name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "default true",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "(in pixels)",
"memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "latitude",
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
+ "memberOf" : "Roo.bootstrap.TextArea"
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
"type" : "Number",
- "desc" : "Position when init default 0",
- "memberOf" : ""
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "locationName",
+ "name" : "maskRe",
"type" : "String",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "longitude",
+ "name" : "maxLength",
"type" : "Number",
- "desc" : "Position when init default 0",
- "memberOf" : ""
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "mapTypeControl",
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "mapTypeId",
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "default google.maps.MapTypeId.ROADMAP",
- "memberOf" : ""
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "markerTitle",
+ "name" : "resizable",
"type" : "String",
- "desc" : "",
+ "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
"memberOf" : ""
},
{
- "name" : "name",
+ "name" : "resize",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "l)",
+ "memberOf" : "Roo.bootstrap.TextArea",
+ "optvals" : [
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
+ ]
},
{
- "name" : "radius",
+ "name" : "rows",
"type" : "Number",
- "desc" : "default 0",
- "memberOf" : ""
+ "desc" : "Specifies the visible number of lines in a text area",
+ "memberOf" : "Roo.bootstrap.TextArea"
},
{
- "name" : "scrollwheel",
+ "name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "streetViewControl",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "stylesheets",
+ "type" : "Array",
+ "desc" : "url of stylesheets. set to [] to disable stylesheets.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "toolbars",
+ "type" : "Array",
+ "desc" : "Array of toolbars. - defaults to just the Standard one",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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.Input"
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "(in pixels)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "wrap",
+ "type" : "string",
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form",
+ "memberOf" : "Roo.bootstrap.TextArea",
+ "optvals" : [
+ "soft",
+ "hard"
+ ]
},
{
"name" : "xattr",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "zoom",
+ "name" : "xs",
"type" : "Number",
- "desc" : "default 15",
- "memberOf" : ""
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
{
- "name" : "OverlayViewDraw",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires when OverlayView Draw",
+ "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "OverlayViewHide",
+ "name" : "autosave",
"type" : "function",
- "desc" : "Fires when OverlayView Draw",
+ "desc" : "Auto save the htmlEditor value as a file into Events",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "OverlayViewOnAdd",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when OverlayView Draw",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "OverlayViewOnRemove",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when OverlayView Draw",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "OverlayViewShow",
+ "name" : "beforepush",
"type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self, cpx)\n{\n\n}",
+ "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
+ "sig" : "function (_self, html)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "beforedestroy",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
{
- "name" : "beforehide",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
{
- "name" : "beforerender",
+ "name" : "beforesync",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "beforeshow",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "childrenrendered",
"memberOf" : "Roo.Component"
},
{
- "name" : "enable",
+ "name" : "editmodechange",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Fires when the editor switches edit modes",
+ "sig" : "function (_self, sourceEdit)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "hide",
+ "name" : "editorevent",
"type" : "function",
- "desc" : "Fires when the map hide.",
+ "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "initial",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the picker initialized.",
- "sig" : "function (_self, location)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "loadexception",
+ "name" : "firstfocus",
"type" : "function",
- "desc" : "Fires when load google lib failed.",
+ "desc" : "Fires when on first focus - needed by toolbars..",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "mapClick",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires when click the map.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "mapRightClick",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when right click the map.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "markerClick",
+ "name" : "initialize",
"type" : "function",
- "desc" : "Fires when click the marker.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires when the editor is fully initialized (including the iframe)",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "markerRightClick",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fires when right click the marker.",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "positionchanged",
+ "name" : "push",
"type" : "function",
- "desc" : "Fires when the picker position changed.",
- "sig" : "function (_self, location)\n{\n\n}",
+ "desc" : "Fires when the iframe editor is updated with content from the textarea.",
+ "sig" : "function (_self, html)\n{\n\n}",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "resize",
+ "name" : "savedpreview",
"type" : "function",
- "desc" : "Fires when the map resize.",
+ "desc" : "preview the saved version of htmlEditor",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when the map show.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
"memberOf" : ""
+ },
+ {
+ "name" : "sync",
+ "type" : "function",
+ "desc" : "Fires when the textarea is updated with content from the editor iframe.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TextArea"
+ },
+ {
+ "name" : "createToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
+ "sig" : "(editor)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real textarea element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TextArea"
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TextArea"
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TextArea"
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "toggleSourceEdit",
+ "type" : "function",
+ "desc" : "Toggles the editor between standard and source edit mode.",
+ "sig" : "(sourceEdit)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "tooltipEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.MasonryBrick" : {
+ "Roo.bootstrap.Img" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "bgimage",
+ "name" : "alt",
"type" : "String",
- "desc" : "",
+ "desc" : "image alternative text",
+ "memberOf" : ""
+ },
+ {
+ "name" : "border",
+ "type" : "String",
+ "desc" : "rounded | circle | thumbnail",
"memberOf" : ""
},
{
{
"name" : "cls",
"type" : "String",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
+ "desc" : "a tag href",
"memberOf" : ""
},
{
- "name" : "inverse",
+ "name" : "imgResponsive",
"type" : "Boolean",
- "desc" : "defalut false",
+ "desc" : "false | true",
"memberOf" : ""
},
{
- "name" : "isFitContainer",
- "type" : "Boolean",
- "desc" : "defalut true",
+ "name" : "lgUrl",
+ "type" : "String",
+ "desc" : "lg image source",
"memberOf" : ""
},
{
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "mdUrl",
+ "type" : "String",
+ "desc" : "md image source",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "placetitle",
+ "name" : "smUrl",
"type" : "String",
- "desc" : [
- "(center",
- "bottom)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "defalut false",
+ "desc" : "sm image source",
"memberOf" : ""
},
{
- "name" : "size",
+ "name" : "src",
"type" : "String",
- "desc" : [
- "(xs",
- "sm",
- "md",
- "md-left",
- "md-right",
- "tall",
- "wide)"
- ],
+ "desc" : "image source",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "title",
+ "name" : "target",
"type" : "String",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "p)target for a href.",
+ "memberOf" : "",
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top"
+ ]
},
{
"name" : "tooltip",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "videourl",
- "type" : "String",
- "desc" : "",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xsUrl",
+ "type" : "String",
+ "desc" : "xs image source",
+ "memberOf" : ""
}
],
"events" : [
{
"name" : "click",
"type" : "function",
- "desc" : "When a MasonryBrick is clcik",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : ""
},
{
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a masonry brick based on the masonry brick ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Masonry Brick",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "releaseCapture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setSrc",
+ "type" : "function",
+ "desc" : "Sets the url of the image - used to update it",
+ "sig" : "(url)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.Menu" : {
+ "Roo.bootstrap.Input" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : ""
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : ""
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : ""
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "hidden",
- "type" : "bool",
- "desc" : "if the menu should be hidden when rendered.",
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : ""
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
"memberOf" : ""
},
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "isLink",
- "type" : "bool",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "",
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : ""
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : ""
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "",
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : ""
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
"memberOf" : ""
},
{
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : ""
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : ""
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : ""
},
{
- "name" : "registerMenu",
+ "name" : "preventMark",
"type" : "Boolean",
- "desc" : "True (default) - means that clicking on screen etc. hides it.",
+ "desc" : "Do not show tick or cross if error/success",
"memberOf" : ""
},
{
- "name" : "stopEvent",
- "type" : "bool",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : ""
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : ""
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : ""
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "type",
+ "name" : "validClass",
"type" : "String",
- "desc" : [
- "(dropdown",
- "treeview",
- "submenu)"
- ],
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : ""
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : ""
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
"memberOf" : ""
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : ""
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : ""
}
],
"events" : [
{
"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"
},
{
"name" : "beforerender",
{
"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"
},
{
- "name" : "childrenrendered",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
- "name" : "click",
+ "name" : "change",
"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}",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
"memberOf" : ""
},
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
{
"name" : "destroy",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "hide",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "itemclick",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a menu item contained in this menu is clicked",
- "sig" : "function (baseItem, e)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "mouseout",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "mouseover",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : ""
},
{
{
"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" : "Roo.Component"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
}
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
{
"name" : "getVisibilityEl",
"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"
},
{
"name" : "initEvents",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "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" : ""
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
{
"name" : "show",
"type" : "function",
- "desc" : "Displays this menu relative to another element",
- "sig" : "(element, position, parentMenu)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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"
},
{
"name" : "tooltipEl",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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.MenuItem" : {
+ "Roo.bootstrap.LayoutMasonry" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "used on sidebars to highlight active itesm",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "alternativePadWidth",
+ "type" : "Number",
+ "desc" : "padding below box..",
+ "memberOf" : ""
},
{
- "name" : "container_method",
+ "name" : "boxHeight",
+ "type" : "Number",
+ "desc" : "- 0 for square, or fix it at a certian height",
+ "memberOf" : ""
+ },
+ {
+ "name" : "boxWidth",
+ "type" : "Number",
+ "desc" : "width of the columns",
+ "memberOf" : ""
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component"
"memberOf" : "Roo.Component"
},
{
- "name" : "fa",
- "type" : "String",
- "desc" : "favicon to show on left of menu item.",
+ "name" : "gutter",
+ "type" : "Number",
+ "desc" : "gutter width..",
"memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
+ "name" : "isAutoInitial",
+ "type" : "Boolean",
+ "desc" : "defalut true",
"memberOf" : ""
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "the menu label",
+ "name" : "isHorizontal",
+ "type" : "Boolean",
+ "desc" : "defalut false",
"memberOf" : ""
},
{
- "name" : "isContainer",
+ "name" : "isLayoutInstant",
"type" : "Boolean",
- "desc" : "is it a container - just returns a drop down item..",
+ "desc" : "= no animation?",
"memberOf" : ""
},
{
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "menu",
- "type" : "Roo.bootsrap.Menu",
- "desc" : "the child menu.",
+ "name" : "maxCols",
+ "type" : "Number",
+ "desc" : "maximum number of columns",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "do not trigger A href on clicks (default false).",
+ "name" : "padWidth",
+ "type" : "Number",
+ "desc" : "padding below box..",
"memberOf" : ""
},
{
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "layout",
+ "type" : "function",
+ "desc" : "Fire after layout the items",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "render",
"type" : "function",
}
],
"methods" : [
+ {
+ "name" : "_processVerticalLayoutQueue",
+ "type" : "function",
+ "desc" : "Sets position of item in DOM",
+ "sig" : "(item, x, y, isInstant)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "addBrick",
+ "type" : "function",
+ "desc" : "adds a Masonry Brick",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "addEvents",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearAll",
+ "type" : "function",
+ "desc" : "clear all the Masonry Brick",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a Masonry Layout based on the masonry layout ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
+ },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Masonry Brick",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Masonry Layout",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
+ },
{
"name" : "releaseCapture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "removeBrick",
+ "type" : "function",
+ "desc" : "remove a Masonry Brick",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "removeListener",
"type" : "function",
}
]
},
- "Roo.bootstrap.MenuMgr" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "get",
- "type" : "function",
- "desc" : "Returns a {@link Roo.menu.Menu} object",
- "sig" : "(menu)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "hideAll",
- "type" : "function",
- "desc" : "Hides all menus that are currently visible",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.bootstrap.MenuSeparator" : {
+ "Roo.bootstrap.LayoutMasonryAuto" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "columnWidth",
+ "type" : "Number",
+ "desc" : "width of the columns",
+ "memberOf" : ""
+ },
{
"name" : "container_method",
"type" : "string",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "isAutoInitial",
+ "type" : "Boolean",
+ "desc" : "defalut true",
+ "memberOf" : ""
+ },
+ {
+ "name" : "isFitWidth",
+ "type" : "Boolean",
+ "desc" : "- resize the width..",
+ "memberOf" : ""
+ },
+ {
+ "name" : "isLayoutInstant",
+ "type" : "Boolean",
+ "desc" : "= no animation?",
+ "memberOf" : ""
+ },
+ {
+ "name" : "isOriginLeft",
+ "type" : "Boolean",
+ "desc" : "= left align?",
+ "memberOf" : ""
+ },
+ {
+ "name" : "isOriginTop",
+ "type" : "Boolean",
+ "desc" : "= top align?",
+ "memberOf" : ""
+ },
+ {
+ "name" : "isResizingContainer",
+ "type" : "Boolean",
+ "desc" : "= not sure if this is used..",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "maxCols",
+ "type" : "Number",
+ "desc" : "maximum number of columns",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "padHeight",
+ "type" : "Number",
+ "desc" : "padding below box..",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
],
"methods" : [
+ {
+ "name" : "_getColGroup",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "(colSpan)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "_postLayout",
+ "type" : "function",
+ "desc" : "Any logic you want to do after each layout,\ni.e. size the container",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "_processLayoutQueue",
+ "type" : "function",
+ "desc" : "Sets position of item in DOM",
+ "sig" : "(item, x, y, isInstant)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "addEvents",
"type" : "function",
}
]
},
- "Roo.bootstrap.MessageBar" : {
+ "Roo.bootstrap.Link" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "beforeClass",
+ "name" : "alt",
"type" : "String",
- "desc" : "insert the bar before the given class",
+ "desc" : "image alternative text",
+ "memberOf" : ""
+ },
+ {
+ "name" : "anchor",
+ "type" : "String",
+ "desc" : "name for the anchor link",
"memberOf" : ""
},
{
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "fixed",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- favicon",
"memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "a tag href",
+ "memberOf" : ""
},
{
"name" : "html",
"type" : "String",
- "desc" : "contents of the MessageBar",
+ "desc" : "the content of the link.",
"memberOf" : ""
},
{
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "p) target for a href.",
+ "memberOf" : "",
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : [
- "(info",
- "success",
- "warning",
- "danger)"
- ],
- "memberOf" : ""
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
- "Roo.bootstrap.MessageBox" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "alert",
- "type" : "function",
- "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
- "sig" : "(title, msg, fn, scope)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "confirm",
- "type" : "function",
- "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).",
- "sig" : "(title, msg, fn, scope)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "getDialog",
- "type" : "function",
- "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides the message box if it is displayed",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if the message box is currently displayed",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "progress",
- "type" : "function",
- "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
- "sig" : "(title, msg)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "prompt",
- "type" : "function",
- "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
- "sig" : "(title, msg, fn, scope, multiline)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "updateProgress",
- "type" : "function",
- "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
- "sig" : "(value, text)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "updateText",
- "type" : "function",
- "desc" : "Updates the message box body text",
- "sig" : "(text)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "wait",
- "type" : "function",
- "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
- "sig" : "(msg, title)",
- "static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.bootstrap.Modal" : {
+ "Roo.bootstrap.LocationPicker" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "allow_close",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
- },
- {
- "name" : "buttonPosition",
- "type" : "String",
- "desc" : [
- "(left",
- "right",
- "center)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "buttons",
- "type" : "Array",
- "desc" : "Array of buttons or standard button set..",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "fitwindow",
+ "name" : "disableDoubleClickZoom",
"type" : "Boolean",
"desc" : "default false",
"memberOf" : ""
},
+ {
+ "name" : "draggable",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : ""
+ },
+ {
+ "name" : "enableAutocomplete",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : ""
+ },
+ {
+ "name" : "enableReverseGeocode",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : ""
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
+ "name" : "latitude",
+ "type" : "Number",
+ "desc" : "Position when init default 0",
"memberOf" : ""
},
{
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "max_width",
+ "name" : "locationName",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : ""
+ },
+ {
+ "name" : "longitude",
"type" : "Number",
- "desc" : "set the max width of modal",
+ "desc" : "Position when init default 0",
+ "memberOf" : ""
+ },
+ {
+ "name" : "mapTypeControl",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : ""
+ },
+ {
+ "name" : "mapTypeId",
+ "type" : "String",
+ "desc" : "default google.maps.MapTypeId.ROADMAP",
+ "memberOf" : ""
+ },
+ {
+ "name" : "markerTitle",
+ "type" : "String",
+ "desc" : "",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "size",
- "type" : "String",
- "desc" : [
- "(sm",
- "lg)"
- ],
+ "name" : "radius",
+ "type" : "Number",
+ "desc" : "default 0",
"memberOf" : ""
},
{
- "name" : "specificTitle",
+ "name" : "scrollwheel",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : ""
+ },
+ {
+ "name" : "streetViewControl",
"type" : "Boolean",
"desc" : "default false",
"memberOf" : ""
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "Title of dialog",
- "memberOf" : ""
- },
- {
- "name" : "tmpl",
- "type" : "Roo.Template",
- "desc" : "- a template with variables. to use it, add a handler in show:method adn",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "zoom",
+ "type" : "Number",
+ "desc" : "default 15",
+ "memberOf" : ""
}
],
"events" : [
+ {
+ "name" : "OverlayViewDraw",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "OverlayViewHide",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "OverlayViewOnAdd",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "OverlayViewOnRemove",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "OverlayViewShow",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self, cpx)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "btnclick",
- "type" : "function",
- "desc" : "The raw btnclick event for the button",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "childrenrendered",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires when the map hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
+ },
+ {
+ "name" : "initial",
+ "type" : "function",
+ "desc" : "Fires when the picker initialized.",
+ "sig" : "function (_self, location)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "loadexception",
+ "type" : "function",
+ "desc" : "Fires when load google lib failed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "mapClick",
+ "type" : "function",
+ "desc" : "Fires when click the map.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "mapRightClick",
+ "type" : "function",
+ "desc" : "Fires when right click the map.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "markerClick",
+ "type" : "function",
+ "desc" : "Fires when click the marker.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "markerRightClick",
+ "type" : "function",
+ "desc" : "Fires when right click the marker.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "positionchanged",
+ "type" : "function",
+ "desc" : "Fires when the picker position changed.",
+ "sig" : "function (_self, location)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "render",
{
"name" : "resize",
"type" : "function",
- "desc" : "Fire when dialog resize",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires when the map resize.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when the map show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
}
],
"methods" : [
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "applyBody",
- "type" : "function",
- "desc" : "Set the body of the Dialog using the template",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setBody",
- "type" : "function",
- "desc" : "Set the body of the Dialog",
- "sig" : "(str)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "Set the title of the Dialog",
- "sig" : "(str)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.MoneyField" : {
+ "Roo.bootstrap.MasonryBrick" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowDecimals",
- "type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "allowZero",
- "type" : "Boolean",
- "desc" : "False to blank out if the user enters '0' (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "append",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "autoFocus",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "btnPosition",
+ "name" : "bgimage",
"type" : "String",
- "desc" : "set the position of the trigger button (left | right) default right",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "",
+ "memberOf" : ""
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : [
- "(search",
- "calendar)"
- ],
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "castInt",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "",
+ "memberOf" : ""
},
{
"name" : "container_method",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "decimalSeparator",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "defaults",
+ "name" : "href",
"type" : "String",
- "desc" : "currency of the MoneyField\nvalue should be in lkey",
+ "desc" : "",
"memberOf" : ""
},
{
- "name" : "disableClass",
+ "name" : "html",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "desc" : "",
+ "memberOf" : ""
},
{
- "name" : "disableClear",
+ "name" : "inverse",
"type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "defalut false",
+ "memberOf" : ""
},
{
- "name" : "disableKeyFilter",
+ "name" : "isFitContainer",
"type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "defalut true",
+ "memberOf" : ""
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "placetitle",
+ "type" : "String",
+ "desc" : "m)",
+ "memberOf" : "",
+ "optvals" : [
+ "center",
+ "bottom"
+ ]
},
{
- "name" : "emptyResultText",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "only for touch device",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "defalut false",
+ "memberOf" : ""
},
{
- "name" : "emptyTitle",
+ "name" : "size",
"type" : "String",
- "desc" : "default ''",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e)",
+ "memberOf" : "",
+ "optvals" : [
+ "xs",
+ "sm",
+ "md",
+ "md-left",
+ "md-right",
+ "tall",
+ "wide"
+ ]
},
{
- "name" : "focusClass",
+ "name" : "style",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "title",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : ""
},
{
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "grow",
- "type" : "Boolean",
+ "name" : "videourl",
+ "type" : "String",
"desc" : "",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "memberOf" : ""
},
{
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
{
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "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"
},
{
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "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"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
+ "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"
},
{
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.TriggerField"
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a MasonryBrick is clcik",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ }
+ ],
+ "methods" : [
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "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"
},
{
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a masonry brick based on the masonry brick ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "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"
},
{
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "maxText",
- "type" : "String",
- "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
- "memberOf" : ""
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "max_length",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
+ "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"
},
{
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Masonry Brick",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
},
{
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minText",
- "type" : "String",
- "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
- "memberOf" : ""
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : ""
+ "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"
},
{
- "name" : "mobileTouchView",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "mobile_restrict_height",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "modalTitle",
- "type" : "String",
- "desc" : "The title of the dialog that pops up on mobile views.",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "mode",
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.bootstrap.Menu" : {
+ "props" : [
+ {
+ "name" : "actionMode",
"type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "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" : "multiple",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "nanText",
+ "name" : "cls",
"type" : "String",
- "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
- "memberOf" : ""
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "placeholder",
+ "name" : "container_method",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "regexText",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "hidden",
+ "type" : "bool",
+ "desc" : "if the menu should be hidden when rendered.",
+ "memberOf" : ""
},
{
- "name" : "selectedClass",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "isLink",
+ "type" : "bool",
+ "desc" : "e) the menu has link disable auto expand and collaspe (default false)",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "showToggleBtn",
- "type" : "Boolean",
- "desc" : "show toggle button or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "size",
+ "name" : "name",
"type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "specialFilter",
+ "name" : "registerMenu",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf" : ""
},
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "stopEvent",
+ "type" : "bool",
+ "desc" : "e) Stop event after trigger press (default true)",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "thousandsDelimiter",
- "type" : "String",
- "desc" : "Symbol of thousandsDelimiter",
- "memberOf" : ""
- },
- {
- "name" : "tickable",
- "type" : "Boolean",
- "desc" : "ComboBox with tickable selections (true|false), default false",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "tooltip",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "triggerList",
- "type" : "Boolean",
- "desc" : "trigger show the list or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "triggerText",
- "type" : "String",
- "desc" : "multiple combobox trigger button text default 'Select'",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "useNativeIOS",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "valueNotFoundText",
+ "name" : "type",
"type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "u) type of menu",
+ "memberOf" : "",
+ "optvals" : [
+ "dropdown",
+ "treeview",
+ "submenu"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "afterremove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "beforedestroy",
"type" : "function",
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before this menu is hidden (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "memberOf" : ""
},
{
"name" : "beforerender",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before this menu is displayed (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : ""
},
{
"name" : "childrenrendered",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "collapse",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "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" : ""
},
{
"name" : "destroy",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "enable",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after this menu is hidden",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "invalid",
+ "name" : "itemclick",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when a menu item contained in this menu is clicked",
+ "sig" : "function (baseItem, e)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "keyup",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "remove",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "render",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "specialfilter",
- "type" : "function",
- "desc" : "Fires when specialfilter",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "tick",
- "type" : "function",
- "desc" : "Fires when tick the element",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "touchviewdisplay",
- "type" : "function",
- "desc" : "Fires when touch view require special display (default is using displayField)",
- "sig" : "function (combo, cfg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after this menu is displayed",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : ""
}
],
"methods" : [
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "capture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "fireEvent",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "getVisibilityEl",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "initEvents",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "setVisibilityEl",
"type" : "function",
{
"name" : "show",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
+ },
+ {
+ "name" : "showAt",
+ "type" : "function",
+ "desc" : "Displays this menu at a specific xy position",
+ "sig" : "(xyPosition, parentMenu)",
+ "static" : false,
+ "memberOf" : ""
},
{
"name" : "tooltipEl",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.MonthField" : {
+ "Roo.bootstrap.MenuItem" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "used on sidebars to highlight active itesm",
+ "memberOf" : ""
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "favicon to show on left of menu item.",
+ "memberOf" : ""
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "href",
+ "type" : "String",
+ "desc" : "the link",
+ "memberOf" : ""
},
{
- "name" : "focusClass",
+ "name" : "html",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "the menu label",
+ "memberOf" : ""
},
{
- "name" : "forceFeedback",
+ "name" : "isContainer",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "is it a container - just returns a drop down item..",
+ "memberOf" : ""
},
{
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "menu",
+ "type" : "Roo.bootsrap.Menu",
+ "desc" : "the child menu.",
+ "memberOf" : ""
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "do not trigger A href on clicks (default false).",
+ "memberOf" : ""
},
{
- "name" : "invalidClass",
+ "name" : "style",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "language",
- "type" : "String",
- "desc" : "default en",
- "memberOf" : ""
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "childrenrendered",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "destroy",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
+ }
+ ]
+ },
+ "Roo.bootstrap.MenuMgr" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "validate",
+ "name" : "get",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns a {@link Roo.menu.Menu} object",
+ "sig" : "(menu)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : ""
},
{
- "name" : "validateValue",
+ "name" : "hideAll",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Hides all menus that are currently visible",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : ""
}
]
},
- "Roo.bootstrap.NavGroup" : {
+ "Roo.bootstrap.MenuSeparator" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "navId",
- "type" : "String",
- "desc" : "- reference Id for navbar.",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : [
- "(nav",
- "pills",
- "tab)"
- ],
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "childrenrendered",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "addItem",
- "type" : "function",
- "desc" : "adds a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "addListener",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearAll",
- "type" : "function",
- "desc" : "clear all the Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
- {
- "name" : "getActive",
- "type" : "function",
- "desc" : "gets the active Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "releaseCapture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setActiveItem",
- "type" : "function",
- "desc" : "sets the active Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setDisabled",
"type" : "function",
}
]
},
- "Roo.bootstrap.NavHeaderbar" : {
+ "Roo.bootstrap.MessageBar" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "autohide",
- "type" : "Boolean",
- "desc" : "a top nav bar header that hides on scroll.",
- "memberOf" : ""
- },
- {
- "name" : "brand",
- "type" : "String",
- "desc" : "what is brand",
- "memberOf" : ""
- },
- {
- "name" : "brand_href",
+ "name" : "beforeClass",
"type" : "String",
- "desc" : "href of the brand",
+ "desc" : "insert the bar before the given class",
"memberOf" : ""
},
{
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "desktopCenter",
- "type" : "Boolean",
- "desc" : "should the header be centered on desktop using a container class",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "fixed",
+ "type" : "Boolean",
+ "desc" : "e) default false, fix the bar at the top",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the MessageBar",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "mobilerow",
- "type" : "Roo.bootstrap.Row",
- "desc" : "- a row to display on mobile only..",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "position",
- "type" : "String",
- "desc" : [
- "(fixed-top",
- "fixed-bottom",
- "static-top)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "srButton",
- "type" : "Boolean",
- "desc" : "generate the (screen reader / mobile) sr-only button default true",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : [
- "(header",
- "footer",
- "nav",
- "div)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : [
- "(nav",
- "pills",
- "tabs)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : [
- "(light",
- "primary",
- "secondary",
+ "desc" : "r) default info",
+ "memberOf" : "",
+ "optvals" : [
+ "info",
"success",
- "danger",
"warning",
- "info",
- "dark",
- "white)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
+ "danger"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforetoggle",
- "type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar"
- },
{
"name" : "childrenrendered",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar"
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- "Roo.bootstrap.NavItem" : {
+ "Roo.bootstrap.MessageBox" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "alert",
+ "type" : "function",
+ "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "confirm",
+ "type" : "function",
+ "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getDialog",
+ "type" : "function",
+ "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides the message box if it is displayed",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if the message box is currently displayed",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "progress",
+ "type" : "function",
+ "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
+ "sig" : "(title, msg)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "prompt",
+ "type" : "function",
+ "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
+ "sig" : "(title, msg, fn, scope, multiline)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "updateProgress",
+ "type" : "function",
+ "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
+ "sig" : "(value, text)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "updateText",
+ "type" : "function",
+ "desc" : "Updates the message box body text",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "wait",
+ "type" : "function",
+ "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
+ "sig" : "(msg, title)",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.bootstrap.Modal" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "animateRef",
+ "name" : "allow_close",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "default true",
"memberOf" : ""
},
{
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "default true",
"memberOf" : ""
},
{
- "name" : "badgecls",
+ "name" : "buttonPosition",
"type" : "String",
- "desc" : [
- "(bg-green",
- "bg-red",
- "bg-yellow)"
- ],
- "memberOf" : ""
+ "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left",
+ "memberOf" : "",
+ "optvals" : [
+ "left",
+ "right",
+ "center"
+ ]
},
{
- "name" : "button_weight",
- "type" : "String",
- "desc" : [
- "(default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link )"
- ],
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "Array of buttons or standard button set..",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "disabled",
+ "name" : "editableTitle",
"type" : "Boolean",
- "desc" : "Is item disabled",
+ "desc" : "can the title be edited",
"memberOf" : ""
},
{
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "name" : "fitwindow",
+ "type" : "Boolean",
+ "desc" : "default false",
"memberOf" : ""
},
{
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "fixed height - usefull for chrome extension only really.",
"memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
- "desc" : "content of button",
- "memberOf" : ""
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
+ "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
"memberOf" : ""
},
{
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "max_width",
+ "type" : "Number",
+ "desc" : "set the max width of modal",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "preventDefault",
+ "name" : "size",
+ "type" : "String",
+ "desc" : "g) default empty",
+ "memberOf" : "",
+ "optvals" : [
+ "sm",
+ "lg"
+ ]
+ },
+ {
+ "name" : "specificTitle",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "default false",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tabId",
+ "name" : "title",
"type" : "String",
- "desc" : "the tab that this item activates.",
+ "desc" : "Title of dialog",
"memberOf" : ""
},
{
- "name" : "tagtype",
- "type" : "String",
- "desc" : [
- "(a",
- "span)"
- ],
+ "name" : "tmpl",
+ "type" : "Roo.Template",
+ "desc" : "- a template with variables. to use it, add a handler in show:method adn",
"memberOf" : ""
},
{
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "fixed width - usefull for chrome extension only really.",
+ "memberOf" : ""
},
{
"name" : "xattr",
"memberOf" : "Roo.Component"
},
{
- "name" : "changed",
+ "name" : "btnclick",
"type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
+ "desc" : "The raw btnclick event for the button",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : ""
},
{
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "scrollto",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
+ "desc" : "Fire when dialog resize",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : ""
},
{
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "titlechanged",
+ "type" : "function",
+ "desc" : "Fire when the editable title has been changed",
+ "sig" : "function (_self, value)\n{\n\n}",
+ "memberOf" : ""
}
],
"methods" : [
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "applyBody",
+ "type" : "function",
+ "desc" : "Set the body of the Dialog using the template",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setBody",
+ "type" : "function",
+ "desc" : "Set the body of the Dialog",
+ "sig" : "(str)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "Set the title of the Dialog",
+ "sig" : "(str)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "un",
}
]
},
- "Roo.bootstrap.NavProgressBar" : {
+ "Roo.bootstrap.MoneyField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowNegative",
+ "type" : "Boolean",
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "allowZero",
+ "type" : "Boolean",
+ "desc" : "False to blank out if the user enters '0' (defaults to true)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "autoFocus",
+ "type" : "Boolean",
+ "desc" : "e) auto focus the first item, default true",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "btnPosition",
+ "type" : "String",
+ "desc" : "set the position of the trigger button (left | right) default right",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
+ },
+ {
+ "name" : "castInt",
+ "type" : "Boolean",
+ "desc" : "e) cast int if true (defalut true)",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "decimalPrecision",
+ "type" : "Number",
+ "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "decimalSeparator",
+ "type" : "String",
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "defaults",
+ "type" : "String",
+ "desc" : "currency of the MoneyField\nvalue should be in lkey",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "style",
+ "name" : "displayField",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "emptyResultText",
+ "type" : "Boolean",
+ "desc" : "only for touch device",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
+ "name" : "emptyTitle",
+ "type" : "String",
+ "desc" : "default ''",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
- "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"
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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"
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "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"
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : ""
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- }
- ],
- "methods" : [
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
{
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "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"
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
- "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"
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "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"
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : 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"
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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"
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "memberOf" : ""
},
{
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : ""
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "max_length",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : ""
},
{
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.bootstrap.NavProgressItem" : {
- "props" : [
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
- "name" : "actionMode",
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLengthText",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
"memberOf" : ""
},
{
- "name" : "allowDomMove",
+ "name" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "mobileTouchView",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "e) show mobile touch view when using a mobile default true",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "can_build_overlaid",
+ "name" : "mobile_restrict_height",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "e) restrict height for touch view",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "cls",
+ "name" : "modalTitle",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "The title of the dialog that pops up on mobile views.",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "multiple",
+ "type" : "Boolean",
+ "desc" : "e) ComboBobArray, default false",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "disableClass",
+ "name" : "name",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "nanText",
+ "type" : "String",
+ "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
"memberOf" : ""
},
{
- "name" : "hideMode",
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "queryParam",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "html",
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "icon",
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "selectedClass",
"type" : "String",
- "desc" : "show icon instead of number",
- "memberOf" : ""
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
- "name" : "name",
+ "name" : "showToggleBtn",
+ "type" : "Boolean",
+ "desc" : "show toggle button or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "size",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "position",
- "type" : "String",
- "desc" : [
- "(top",
- "bottom)"
- ],
- "memberOf" : ""
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "rid",
- "type" : "String",
- "desc" : "the reference id",
- "memberOf" : ""
+ "name" : "specialFilter",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "thousandsDelimiter",
+ "type" : "String",
+ "desc" : "Symbol of thousandsDelimiter",
+ "memberOf" : ""
+ },
+ {
+ "name" : "tickable",
+ "type" : "Boolean",
+ "desc" : "ComboBox with tickable selections (true|false), default false",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
+ {
+ "name" : "triggerList",
+ "type" : "Boolean",
+ "desc" : "trigger show the list or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "triggerText",
+ "type" : "String",
+ "desc" : "multiple combobox trigger button text default 'Select'",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "typeAhead",
+ "type" : "Boolean",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "typeAheadDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "useNativeIOS",
+ "type" : "Boolean",
+ "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
+ "memberOf" : "Roo.bootstrap.ComboBox",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "valueField",
+ "type" : "String",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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.Input"
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "afterremove",
+ "type" : "function",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforequery",
+ "type" : "function",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "beforerender",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "beforeshow",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "childrenrendered",
"type" : "function",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "click",
+ "name" : "collapse",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
},
{
"name" : "destroy",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "enable",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "show",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "specialfilter",
"type" : "function",
- "desc" : "Used to define events on this Observable",
+ "desc" : "Fires when specialfilter",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "tick",
+ "type" : "function",
+ "desc" : "Fires when tick the element",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "touchviewdisplay",
+ "type" : "function",
+ "desc" : "Fires when touch view require special display (default is using displayField)",
+ "sig" : "function (combo, cfg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
"sig" : "(object)",
"static" : false,
"memberOf" : "Roo.util.Observable"
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
{
"name" : "capture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "fireEvent",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.ComboBox"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.NavSidebar" : {
+ "Roo.bootstrap.MonthField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "name",
+ "name" : "fieldLabel",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "style",
+ "name" : "focusClass",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
{
- "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"
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "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"
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "beforetoggle",
- "type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar"
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- }
- ],
- "methods" : [
+ "name" : "language",
+ "type" : "String",
+ "desc" : "default en",
+ "memberOf" : ""
+ },
{
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : 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"
},
{
- "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"
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar"
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar"
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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"
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "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"
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.bootstrap.NavSidebarItem" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "active",
+ "name" : "preventMark",
"type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "allowDomMove",
+ "name" : "readOnly",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "animateRef",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.NavItem"
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "badge",
+ "name" : "regexText",
"type" : "String",
- "desc" : "text inside badge",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "badgecls",
- "type" : "String",
- "desc" : [
- "(bg-green",
- "bg-red",
- "bg-yellow)"
- ],
- "memberOf" : "Roo.bootstrap.NavItem"
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "button_weight",
- "type" : "String",
- "desc" : [
- "(default",
- "primary",
- "secondary",
- "success",
- "info",
- "warning",
- "danger",
- "link )"
- ],
- "memberOf" : "Roo.bootstrap.NavItem"
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "cls",
+ "name" : "style",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "dataId",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "cutomer id",
+ "desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "html",
+ "name" : "validClass",
"type" : "String",
- "desc" : "content of button",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "icon",
+ "name" : "validFeedbackIcon",
"type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "preventDefault",
+ "name" : "validateOnBlur",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tabId",
- "type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tagtype",
- "type" : "String",
- "desc" : [
- "(a",
- "span)"
- ],
- "memberOf" : "Roo.bootstrap.NavItem"
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tooltip",
+ "name" : "value",
"type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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.Input"
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"memberOf" : "Roo.Component"
},
{
- "name" : "changed",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "childrenrendered",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "render",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "scrollto",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when this field show.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.NavItem"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "un",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.NavSimplebar" : {
+ "Roo.bootstrap.NavGroup" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
"name" : "align",
"type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : ""
+ "desc" : "t)",
+ "memberOf" : "",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inverse",
"type" : "Boolean",
- "desc" : "is inverted color",
+ "desc" : "",
"memberOf" : ""
},
{
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "style",
+ "name" : "navId",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- reference Id for navbar.",
+ "memberOf" : ""
},
{
- "name" : "tag",
+ "name" : "style",
"type" : "String",
- "desc" : [
- "(header",
- "footer",
- "nav",
- "div)"
- ],
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "tooltip",
{
"name" : "type",
"type" : "String",
- "desc" : [
- "(nav",
+ "desc" : "b) default nav",
+ "memberOf" : "",
+ "optvals" : [
+ "nav",
"pills",
- "tabs)"
- ],
- "memberOf" : ""
+ "tab"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : [
- "(light",
- "primary",
- "secondary",
- "success",
- "danger",
- "warning",
- "info",
- "dark",
- "white)"
- ],
- "memberOf" : ""
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"memberOf" : "Roo.Component"
},
{
- "name" : "beforetoggle",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar"
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "childrenrendered",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "addItem",
+ "type" : "function",
+ "desc" : "adds a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "addListener",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "collapse",
+ "name" : "clearAll",
"type" : "function",
- "desc" : "Collapse the navbar pulldown",
+ "desc" : "clear all the Navigation item",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Navbar"
+ "memberOf" : ""
},
{
"name" : "destroy",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar"
- },
{
"name" : "fireEvent",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a Navigation Group based on the navigation ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getActive",
+ "type" : "function",
+ "desc" : "gets the active Navigation item",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
+ },
{
"name" : "releaseCapture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setActiveItem",
+ "type" : "function",
+ "desc" : "sets the active Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "setDisabled",
"type" : "function",
}
]
},
- "Roo.bootstrap.Navbar" : {
+ "Roo.bootstrap.NavHeaderbar" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.NavSimplebar"
+ },
+ {
+ "name" : "autohide",
+ "type" : "Boolean",
+ "desc" : "a top nav bar header that hides on scroll.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "brand",
+ "type" : "String",
+ "desc" : "what is brand",
+ "memberOf" : ""
+ },
+ {
+ "name" : "brand_href",
+ "type" : "String",
+ "desc" : "href of the brand",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "desktopCenter",
+ "type" : "Boolean",
+ "desc" : "should the header be centered on desktop using a container class",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.NavSimplebar"
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "mobilerow",
+ "type" : "Roo.bootstrap.Row",
+ "desc" : "- a row to display on mobile only..",
+ "memberOf" : ""
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "p) position",
+ "memberOf" : "",
+ "optvals" : [
+ "fixed-top",
+ "fixed-bottom",
+ "static-top"
+ ]
+ },
+ {
+ "name" : "srButton",
+ "type" : "Boolean",
+ "desc" : "generate the (screen reader / mobile) sr-only button default true",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
"name" : "xattr",
"type" : "function",
"desc" : "Fire before toggle the menu",
"sig" : "function (e)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Navbar"
},
{
"name" : "childrenrendered",
"desc" : "Collapse the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Navbar"
},
{
"name" : "destroy",
"desc" : "Expand the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Navbar"
},
{
"name" : "fireEvent",
}
]
},
- "Roo.bootstrap.NumberField" : {
+ "Roo.bootstrap.NavItem" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowDecimals",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
+ "desc" : "Is item active",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "allowNegative",
+ "name" : "animateRef",
"type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
+ "desc" : "e) link to element default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "allowZero",
- "type" : "Boolean",
- "desc" : "False to blank out if the user enters '0' (defaults to true)",
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
"memberOf" : ""
},
{
- "name" : "autocomplete",
+ "name" : "badgecls",
"type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "w)the extra classes for the badge",
+ "memberOf" : "",
+ "optvals" : [
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
+ ]
},
{
- "name" : "blankText",
+ "name" : "button_weight",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : ") default none",
+ "memberOf" : "",
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link"
+ ]
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
- },
- {
- "name" : "decimalSeparator",
- "type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Is item disabled",
+ "memberOf" : ""
},
{
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : ""
},
{
- "name" : "focusClass",
+ "name" : "glyphicon",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : ""
},
{
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "href",
+ "type" : "String",
+ "desc" : "link to",
+ "memberOf" : ""
},
{
- "name" : "hideMode",
+ "name" : "html",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "content of button",
+ "memberOf" : ""
},
{
- "name" : "indicatorpos",
+ "name" : "icon",
"type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : ""
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "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" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "invalidText",
+ "name" : "style",
"type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "labelAlign",
+ "name" : "tabId",
"type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "the tab that this item activates.",
+ "memberOf" : ""
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "tagtype",
+ "type" : "String",
+ "desc" : "n) render as a href or span?",
+ "memberOf" : "",
+ "optvals" : [
+ "a",
+ "span"
+ ]
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "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" : "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"
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "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"
},
{
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "maxText",
- "type" : "String",
- "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minText",
- "type" : "String",
- "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
- "memberOf" : ""
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : ""
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "nanText",
- "type" : "String",
- "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
- "memberOf" : ""
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "thousandsDelimiter",
- "type" : "String",
- "desc" : "Symbol of thousandsDelimiter",
- "memberOf" : ""
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valueAlign",
- "type" : "String",
- "desc" : "alignment of value",
- "memberOf" : ""
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "render",
+ "name" : "scrollto",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "show",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
"name" : "un",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.Pagination" : {
+ "Roo.bootstrap.NavProgressBar" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "false | true",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "size",
- "type" : "String",
- "desc" : "xs | sm | md | lg",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "childrenrendered",
"type" : "function",
}
]
},
- "Roo.bootstrap.PaginationItem" : {
+ "Roo.bootstrap.NavProgressItem" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
"name" : "active",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "e) Is item active default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "allowDomMove",
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "e) Is item active default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "href",
+ "name" : "html",
"type" : "String",
- "desc" : "the link",
+ "desc" : "",
"memberOf" : ""
},
{
- "name" : "html",
+ "name" : "icon",
"type" : "String",
- "desc" : "text",
+ "desc" : "show icon instead of number",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "position",
+ "type" : "String",
+ "desc" : "m) text position default bottom",
+ "memberOf" : "",
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
+ },
+ {
+ "name" : "rid",
+ "type" : "String",
+ "desc" : "the reference id",
"memberOf" : ""
},
{
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"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" : ""
},
{
}
]
},
- "Roo.bootstrap.PagingToolbar" : {
+ "Roo.bootstrap.NavSidebar" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "container The id or element that will contain the toolbar",
- "memberOf" : ""
- },
{
"name" : "container_method",
"type" : "string",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The underlying data store providing the paged data",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "displayInfo",
- "type" : "Boolean",
- "desc" : "True to display the displayMsg (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "displayMsg",
- "type" : "String",
- "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
- "memberOf" : ""
- },
- {
- "name" : "emptyMsg",
- "type" : "String",
- "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "The number of records to display per page (defaults to 20)",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : [
- "(header",
- "footer",
- "nav",
- "div)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : [
- "(nav",
- "pills",
- "tabs)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : [
- "(light",
- "primary",
- "secondary",
- "success",
- "danger",
- "warning",
- "info",
- "dark",
- "white)"
- ],
- "memberOf" : "Roo.bootstrap.NavSimplebar"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "bind",
- "type" : "function",
- "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
- "sig" : "(store)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "capture",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "unbind",
- "type" : "function",
- "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
- "sig" : "(store)",
- "static" : false,
- "memberOf" : ""
}
]
},
- "Roo.bootstrap.PhoneInput" : {
+ "Roo.bootstrap.NavSidebarItem" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Is item active",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "autocomplete",
+ "name" : "animateRef",
+ "type" : "Boolean",
+ "desc" : "e) link to element default false",
+ "memberOf" : "Roo.bootstrap.NavItem",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "badge",
"type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "text inside badge",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "badgecls",
+ "type" : "String",
+ "desc" : "w)the extra classes for the badge",
+ "memberOf" : "Roo.bootstrap.NavItem",
+ "optvals" : [
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
+ ]
},
{
- "name" : "blankText",
+ "name" : "button_weight",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : ") default none",
+ "memberOf" : "Roo.bootstrap.NavItem",
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link"
+ ]
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : [
- "(search",
- "calendar)"
- ],
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "defaultDialCode",
- "type" : "String",
- "desc" : "default '+852'",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.TriggerField"
+ "desc" : "Is item disabled",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
- "name" : "indicatorpos",
+ "name" : "fa",
"type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
- "name" : "inputType",
+ "name" : "glyphicon",
"type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
- "name" : "invalidClass",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "invalidFeedbackIcon",
+ "name" : "href",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "link to",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
- "name" : "invalidText",
+ "name" : "html",
"type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "content of button",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
- "name" : "labelAlign",
+ "name" : "icon",
"type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "preferedCountries",
- "type" : "Array",
- "desc" : "default []",
- "memberOf" : ""
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.TriggerField"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "selectOnFocus",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.NavItem",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "validClass",
+ "name" : "tabId",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "the tab that this item activates.",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
- "name" : "validFeedbackIcon",
+ "name" : "tagtype",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "n) render as a href or span?",
+ "memberOf" : "Roo.bootstrap.NavItem",
+ "optvals" : [
+ "a",
+ "span"
+ ]
},
{
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"memberOf" : "Roo.Component"
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "childrenrendered",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "render",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "specialkey",
+ "name" : "scrollto",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.NavItem"
},
{
- "name" : "valid",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "capture",
+ "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"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"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.NavItem"
},
{
"name" : "un",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.Popover" : {
+ "Roo.bootstrap.NavSimplebar" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "",
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "delay",
- "type" : "Number",
- "desc" : "- delay before showing",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "contents of the popover (or false to use children..)",
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
"memberOf" : ""
},
{
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "over",
- "type" : "String",
- "desc" : "what (parent or false to trigger manually.)",
- "memberOf" : ""
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "placement",
- "type" : "String",
- "desc" : "how it is placed",
- "memberOf" : ""
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "title",
+ "name" : "tag",
"type" : "String",
- "desc" : "of popover (or false to hide)",
- "memberOf" : ""
+ "desc" : "v) default is nav",
+ "memberOf" : "",
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
},
{
"name" : "tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "trigger",
+ "name" : "type",
"type" : "String",
- "desc" : "click || hover (or false to trigger manually)",
- "memberOf" : ""
+ "desc" : "s)",
+ "memberOf" : "",
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : "",
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Navbar"
+ },
{
"name" : "childrenrendered",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "After the popover hide",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "render",
{
"name" : "show",
"type" : "function",
- "desc" : "After the popover show",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Navbar"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Navbar"
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- "Roo.bootstrap.Progress" : {
+ "Roo.bootstrap.Navbar" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "animated of the progress bar",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "striped",
- "type" : "Boolean",
- "desc" : "striped of the progress bar",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "childrenrendered",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- "Roo.bootstrap.ProgressBar" : {
+ "Roo.bootstrap.NumberField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "aria_valuemax",
- "type" : "Number",
- "desc" : "aria-value max",
+ "name" : "allowNegative",
+ "type" : "Boolean",
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
"memberOf" : ""
},
{
- "name" : "aria_valuemin",
- "type" : "Number",
- "desc" : "aria-value min",
+ "name" : "allowZero",
+ "type" : "Boolean",
+ "desc" : "False to blank out if the user enters '0' (defaults to true)",
"memberOf" : ""
},
{
- "name" : "aria_valuenow",
- "type" : "Number",
- "desc" : "aria-value now",
- "memberOf" : ""
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "disableClass",
+ "name" : "decimalPrecision",
+ "type" : "Number",
+ "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "decimalSeparator",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf" : ""
},
{
- "name" : "hideMode",
+ "name" : "disableClass",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
{
- "name" : "label",
- "type" : "String",
- "desc" : "label for the progress bar",
- "memberOf" : ""
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "name",
+ "name" : "fieldLabel",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "panel",
+ "name" : "focusClass",
"type" : "String",
- "desc" : [
- "(success",
- "info",
- "warning",
- "danger )"
- ],
- "memberOf" : ""
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "role",
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hideMode",
"type" : "String",
- "desc" : "role of the progress bar",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "sr_only",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "text",
- "memberOf" : ""
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "style",
+ "name" : "inputType",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
- "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"
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
- "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"
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- }
- ],
- "methods" : [
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
- "name" : "addEvents",
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "nanText",
+ "type" : "String",
+ "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "thousandsDelimiter",
+ "type" : "String",
+ "desc" : "Symbol of thousandsDelimiter",
+ "memberOf" : ""
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "valueAlign",
+ "type" : "String",
+ "desc" : "alignment of value",
+ "memberOf" : ""
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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.Input"
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
"type" : "function",
"desc" : "Used to define events on this Observable",
"sig" : "(object)",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.Radio" : {
+ "Roo.bootstrap.Pagination" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "boxLabel",
- "type" : "String",
- "desc" : "- the label associated",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "false | true",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "size",
+ "type" : "String",
+ "desc" : "xs | sm | md | lg",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "value",
- "type" : "String",
- "desc" : "- the value of radio",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
]
},
- "Roo.bootstrap.RadioSet" : {
+ "Roo.bootstrap.PaginationItem" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "default false",
+ "memberOf" : ""
},
{
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "focusClass",
+ "name" : "href",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "the link",
+ "memberOf" : ""
},
{
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "indicatorpos",
+ "name" : "html",
"type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "inline",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "text",
"memberOf" : ""
},
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "selectOnFocus",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : [
- "(primary",
- "warning",
- "info",
- "danger",
- "success)"
- ],
- "memberOf" : ""
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the element is checked or unchecked.",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "childrenrendered",
"type" : "function",
{
"name" : "click",
"type" : "function",
- "desc" : "Fires when the element is click.",
- "sig" : "function (_self, item, e)\n{\n\n}",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : ""
},
{
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "render",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.Row" : {
+ "Roo.bootstrap.PagingToolbar" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.NavSimplebar"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "container The id or element that will contain the toolbar",
+ "memberOf" : ""
+ },
{
"name" : "container_method",
"type" : "string",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The underlying data store providing the paged data",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "displayInfo",
+ "type" : "Boolean",
+ "desc" : "True to display the displayMsg (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "displayMsg",
+ "type" : "String",
+ "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "emptyMsg",
+ "type" : "String",
+ "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
+ "memberOf" : ""
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.NavSimplebar"
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "The number of records to display per page (defaults to 20)",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.NavSimplebar",
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
"name" : "xattr",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Navbar"
+ },
{
"name" : "childrenrendered",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "bind",
+ "type" : "function",
+ "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "capture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Navbar"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Navbar"
+ },
{
"name" : "fireEvent",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.bootstrap.SecurePass" : {
- "props" : [
+ },
{
- "name" : "Label",
- "type" : "String/Object",
- "desc" : "for the strength meter (defaults to\n'Password strength:')",
+ "name" : "unbind",
+ "type" : "function",
+ "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
+ "static" : false,
"memberOf" : ""
- },
+ }
+ ]
+ },
+ "Roo.bootstrap.PhoneInput" : {
+ "props" : [
{
"name" : "accept",
"type" : "String",
- "desc" : [
- "(image",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
"video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
{
"name" : "align",
"type" : "String",
- "desc" : [
- "(left",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
"center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "right"
+ ]
},
{
"name" : "allowBlank",
{
"name" : "capture",
"type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
},
{
"name" : "cls",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "defaultDialCode",
+ "type" : "String",
+ "desc" : "default '+852'",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "is it disabled",
"memberOf" : "Roo.bootstrap.Input"
},
- {
- "name" : "errors",
- "type" : "String/Object",
- "desc" : "A Error spec, or true for a default spec (defaults to\n{\n PwdEmpty: \"Please type a password, and then retype it to confirm.\",\n PwdShort: \"Your password must be at least 6 characters long. Please type a different password.\",\n PwdLong: \"Your password can't contain more than 16 characters. Please type a different password.\",\n PwdBadChar: \"The password contains characters that aren't allowed. Please type a different password.\",\n IDInPwd: \"Your password can't include the part of your ID. Please type a different password.\",\n FNInPwd: \"Your password can't contain your first name. Please type a different password.\",\n LNInPwd: \"Your password can't contain your last name. Please type a different password.\"\n})",
- "memberOf" : ""
- },
{
"name" : "fieldLabel",
"type" : "string",
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.TriggerField"
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
{
"name" : "labelAlign",
"type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "pwdStrengths",
- "type" : "String/Object",
- "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
+ "name" : "preferedCountries",
+ "type" : "Array",
+ "desc" : "default []",
"memberOf" : ""
},
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "-- Depricated - use Invalid Text",
"memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.TriggerField",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
{
"name" : "validClass",
"type" : "String",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.TriggerField"
+ },
{
"name" : "purgeListeners",
"type" : "function",
}
]
},
- "Roo.bootstrap.Slider" : {
+ "Roo.bootstrap.Popover" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "delay",
+ "type" : "Number",
+ "desc" : "- delay before showing",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the popover (or false to use children..)",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "over",
+ "type" : "String",
+ "desc" : "what (parent or false to trigger manually.)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "placement",
+ "type" : "String",
+ "desc" : "how it is placed",
+ "memberOf" : ""
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "of popover (or false to hide)",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "trigger",
+ "type" : "String",
+ "desc" : "click || hover (or false to trigger manually)",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "After the popover hide",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
"name" : "render",
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "After the popover show",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
}
],
"methods" : [
}
]
},
- "Roo.bootstrap.SplitBar" : {
+ "Roo.bootstrap.Progress" : {
"props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "animated of the progress bar",
+ "memberOf" : ""
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "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"
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "striped",
+ "type" : "Boolean",
+ "desc" : "striped of the progress bar",
+ "memberOf" : ""
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
}
],
"events" : [
{
- "name" : "beforeresize",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before the splitter is dragged",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "moved",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when the splitter is moved",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "resize",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroy this splitbar.",
- "sig" : "(removeEl)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
"name" : "fireEvent",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "getAdapter",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the adapter this SplitBar uses",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "getMaximumSize",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Gets the maximum size for the resizing element",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getMinimumSize",
+ "name" : "getId",
"type" : "function",
- "desc" : "Gets the minimum size for the resizing element",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
},
{
"name" : "hasListener",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
{
"name" : "on",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "setAdapter",
+ "name" : "render",
"type" : "function",
- "desc" : "Set the adapter this SplitBar uses",
- "sig" : "(adapter)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setCurrentSize",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Sets the initialize size for the resizing element",
- "sig" : "(size)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setMaximumSize",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Sets the maximum size for the resizing element",
- "sig" : "(maxSize)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "setMinimumSize",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Sets the minimum size for the resizing element",
- "sig" : "(minSize)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "getElementSize",
+ "name" : "show",
"type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "setElementSize",
- "type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter"
- }
- ]
- },
- "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "getElementSize",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "setElementSize",
+ "name" : "un",
"type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
}
]
},
- "Roo.bootstrap.TabGroup" : {
+ "Roo.bootstrap.ProgressBar" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "alert",
- "type" : "String",
- "desc" : [
- "(success",
- "info",
- "warning",
- "danger)"
- ],
- "memberOf" : "Roo.bootstrap.Column"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "autoslide",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "aria_valuemax",
+ "type" : "Number",
+ "desc" : "aria-value max",
"memberOf" : ""
},
{
- "name" : "bullets",
- "type" : "Boolean",
- "desc" : "show bullets for the panels",
+ "name" : "aria_valuemin",
+ "type" : "Number",
+ "desc" : "aria-value min",
+ "memberOf" : ""
+ },
+ {
+ "name" : "aria_valuenow",
+ "type" : "Number",
+ "desc" : "aria-value now",
"memberOf" : ""
},
{
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "carousel",
- "type" : "Boolean",
- "desc" : "true to make the group behave like a carousel",
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "fa",
- "type" : "String",
- "desc" : [
- "(ban",
- "check",
- "...)"
- ],
- "memberOf" : "Roo.bootstrap.Column"
- },
- {
- "name" : "fasize",
- "type" : "Number",
- "desc" : [
- "(1",
- "2",
- "....)"
- ],
- "memberOf" : "Roo.bootstrap.Column"
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Column"
- },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "content of column.",
- "memberOf" : "Roo.bootstrap.Column"
- },
- {
- "name" : "icon",
+ "name" : "label",
"type" : "String",
- "desc" : [
- "(info-sign",
- "check",
- "...)"
- ],
- "memberOf" : "Roo.bootstrap.Column"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
- },
- {
- "name" : "lgoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "label for the progress bar",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
- },
- {
- "name" : "mdoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
- },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "navId",
+ "name" : "panel",
"type" : "String",
- "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
- "memberOf" : ""
+ "desc" : ")",
+ "memberOf" : "",
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
- "name" : "showarrow",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "role",
+ "type" : "String",
+ "desc" : "role of the progress bar",
"memberOf" : ""
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
- },
- {
- "name" : "smoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "name" : "sr_only",
+ "type" : "String",
+ "desc" : "text",
+ "memberOf" : ""
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "timer",
- "type" : "Number",
- "desc" : "auto slide timer .. default 0 millisecond",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
- },
- {
- "name" : "xsoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
}
],
"events" : [
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : ""
- },
{
"name" : "releaseCapture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "showPanel",
- "type" : "function",
- "desc" : "show a specific panel",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "tooltipEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.TabPanel" : {
+ "Roo.bootstrap.Radio" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "panel active",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "- the label associated",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "click to link..",
- "memberOf" : ""
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "panel content",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "navId",
- "type" : "String",
- "desc" : "The Roo.bootstrap.NavGroup which triggers show hide ()",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tabId",
- "type" : "String",
- "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "- the value of radio",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
],
"events" : [
- {
- "name" : "beforedeactivate",
- "type" : "function",
- "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active status changes",
- "sig" : "function (_self, state)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "childrenrendered",
"type" : "function",
}
]
},
- "Roo.bootstrap.Table" : {
+ "Roo.bootstrap.RadioSet" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "align",
"type" : "String",
- "desc" : [
- "(left",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
"center",
- "right)"
- ],
- "memberOf" : ""
+ "right"
+ ]
},
{
- "name" : "allowDomMove",
+ "name" : "allowBlank",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "auto_hide_footer",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "auto hide footer if only one page (default false)",
- "memberOf" : ""
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "bgcolor",
+ "name" : "autocomplete",
"type" : "String",
- "desc" : "Specifies the background color for a table",
- "memberOf" : ""
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "border",
- "type" : "Number",
- "desc" : "Specifies whether the table cells should have borders or not",
- "memberOf" : ""
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "bordered",
- "type" : "boolean",
- "desc" : "Add borders to the table",
- "memberOf" : ""
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "can_build_overlaid",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "cellSelection",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "cellpadding",
- "type" : "Number",
- "desc" : "Specifies the space between the cell wall and the cell content",
- "memberOf" : ""
- },
- {
- "name" : "cellspacing",
- "type" : "Number",
- "desc" : "Specifies the space between cells",
- "memberOf" : ""
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
- "desc" : "table class",
- "memberOf" : ""
- },
- {
- "name" : "condensed",
- "type" : "boolean",
- "desc" : "Format condensed",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "footer",
- "type" : "Roo.bootstrap.PagingToolbar",
- "desc" : "a paging toolbar",
- "memberOf" : ""
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "footerShow",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "frame",
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "focusClass",
"type" : "String",
- "desc" : "Specifies which parts of the outside borders that should be visible",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "headerShow",
+ "name" : "forceFeedback",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "hover",
- "type" : "boolean",
- "desc" : "Add hover highlighting",
- "memberOf" : ""
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "layout",
+ "name" : "inline",
+ "type" : "Boolean",
+ "desc" : "e) inline the element (default true)",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "inputType",
"type" : "String",
- "desc" : "table layout (auto | fixed | initial | inherit)",
- "memberOf" : ""
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "lazyLoad",
- "type" : "Boolean",
- "desc" : "auto load data while scrolling to the end (default false)",
- "memberOf" : ""
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "responsive",
- "type" : "boolean",
- "desc" : "Format condensed",
- "memberOf" : ""
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "rowSelection",
+ "name" : "readOnly",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "rules",
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "Specifies which parts of the inside borders that should be visible",
- "memberOf" : ""
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "scrollBody",
+ "name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "sortable",
- "type" : "String",
- "desc" : "Specifies that the table should be sortable",
- "memberOf" : ""
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "striped",
- "type" : "boolean",
- "desc" : "Should the rows be alternative striped",
- "memberOf" : ""
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "summary",
- "type" : "String",
- "desc" : "Specifies a summary of the content of a table",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "Specifies the width of a table",
- "memberOf" : ""
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "s) The text that appears beside the radio",
+ "memberOf" : "",
+ "optvals" : [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"memberOf" : "Roo.Component"
},
{
- "name" : "cellclick",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "cellcontextmenu",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "celldblclick",
+ "name" : "check",
"type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "desc" : "Fires when the element is checked or unchecked.",
+ "sig" : "function (_self, item)\n{\n\n}",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "contextmenu",
+ "name" : "click",
"type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when the element is click.",
+ "sig" : "function (_self, item, e)\n{\n\n}",
"memberOf" : ""
},
{
"memberOf" : "Roo.Component"
},
{
- "name" : "headercontextmenu",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "hide",
"memberOf" : "Roo.Component"
},
{
- "name" : "mouseout",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fires when a mouseout occur",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "mouseover",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fires when a mouseover occur",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "render",
"memberOf" : "Roo.Component"
},
{
- "name" : "rowclass",
- "type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (_self, rowcfg)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "rowclick",
- "type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "rowcontextmenu",
- "type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "rowdblclick",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "rowsrendered",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Fires when all the rows have been rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "show",
+ "name" : "valid",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Forces a resize - used by panel.Grid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "capture",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "clear",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Remove all rows",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "destroy",
"memberOf" : "Roo.Component"
},
{
- "name" : "getGridEl",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the grid's underlying element = used by panel.Grid",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getId",
+ "name" : "getName",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "getVisibilityEl",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "on",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "setDisabled",
+ "name" : "reset",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
"memberOf" : "Roo.Component"
},
{
- "name" : "setRowVisibility",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Show or hide a row.",
- "sig" : "(rowIndex, state)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "setVisibilityEl",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.bootstrap.Table.AbstractSelectionModel" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "name" : "isLocked",
- "type" : "function",
- "desc" : "Returns true if the selections are locked.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "lock",
- "type" : "function",
- "desc" : "Locks the selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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"
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "unlock",
- "type" : "function",
- "desc" : "Unlocks the selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.bootstrap.Table.RowSelectionModel" : {
- "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" : "singleSelect",
- "type" : "Boolean",
- "desc" : "True to allow selection of only one row at a time (defaults to false)",
- "memberOf" : ""
- }
- ],
- "events" : [
- {
- "name" : "afterselectionchange",
- "type" : "function",
- "desc" : "Fires after the selection changes (eg. by key press or clicking)",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "beforerowselect",
- "type" : "function",
- "desc" : "Fires when a row is selected being selected, return false to cancel.",
- "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "rowdeselect",
- "type" : "function",
- "desc" : "Fires when a row is deselected.",
- "sig" : "function (_self, rowIndex)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "rowselect",
- "type" : "function",
- "desc" : "Fires when a row is selected.",
- "sig" : "function (_self, rowIndex, r)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "selectionchange",
- "type" : "function",
- "desc" : "Fires when the selection changes",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "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"
- },
- {
- "name" : "clearSelections",
- "type" : "function",
- "desc" : "Clears all selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "deselectRange",
- "type" : "function",
- "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
- "sig" : "(startRow, endRow)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "deselectRow",
- "type" : "function",
- "desc" : "Deselects a row.",
- "sig" : "(row)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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"
- },
- {
- "name" : "getCount",
- "type" : "function",
- "desc" : "Gets the number of selected rows.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "getSelected",
- "type" : "function",
- "desc" : "Returns the first selected record.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "getSelections",
- "type" : "function",
- "desc" : "Returns the selected records",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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"
- },
- {
- "name" : "hasSelection",
- "type" : "function",
- "desc" : "Returns True if there is a selection.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "isIdSelected",
- "type" : "function",
- "desc" : "Returns True if the specified record id is selected.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "isLocked",
- "type" : "function",
- "desc" : "Returns true if the selections are locked.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel"
- },
- {
- "name" : "isSelected",
- "type" : "function",
- "desc" : "Returns True if the specified row is selected.",
- "sig" : "(record)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "lock",
- "type" : "function",
- "desc" : "Locks the selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel"
- },
- {
- "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"
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "selectAll",
- "type" : "function",
- "desc" : "Selects all rows.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
},
{
- "name" : "selectFirstRow",
+ "name" : "validate",
"type" : "function",
- "desc" : "Selects the first row in the grid.",
+ "desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectLastRow",
- "type" : "function",
- "desc" : "Select the last row.",
- "sig" : "(keepExisting)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectNext",
- "type" : "function",
- "desc" : "Selects the row immediately following the last selected row.",
- "sig" : "(keepExisting)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectPrevious",
- "type" : "function",
- "desc" : "Selects the row that precedes the last selected row.",
- "sig" : "(keepExisting)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectRange",
- "type" : "function",
- "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
- "sig" : "(startRow, endRow, keepExisting)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectRecords",
- "type" : "function",
- "desc" : "Select records.",
- "sig" : "(records, keepExisting)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectRow",
- "type" : "function",
- "desc" : "Selects a row.",
- "sig" : "(row, keepExisting)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectRows",
- "type" : "function",
- "desc" : "Selects multiple rows.",
- "sig" : "(rows, keepExisting)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "unlock",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Unlocks the selections.",
- "sig" : "()\n{\n\n}",
+ "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.Table.AbstractSelectionModel"
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.TableBody" : {
+ "Roo.bootstrap.Row" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "Aligns the content inside the element",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "charoff",
- "type" : "Number",
- "desc" : "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute",
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "element class",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "element tag (thead|tbody|tfoot) default tbody",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "valign",
- "type" : "String",
- "desc" : "Vertical aligns the content inside the <tbody> element",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
]
},
- "Roo.bootstrap.TableCell" : {
+ "Roo.bootstrap.SecurePass" : {
"props" : [
{
- "name" : "abbr",
- "type" : "String",
- "desc" : "Specifies an abbreviated version of the content in a cell",
+ "name" : "Label",
+ "type" : "String/Object",
+ "desc" : "for the strength meter (defaults to\n'Password strength:')",
"memberOf" : ""
},
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "align",
"type" : "String",
- "desc" : "Aligns the content in a cell",
- "memberOf" : ""
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "axis",
+ "name" : "autocomplete",
"type" : "String",
- "desc" : "Categorizes cells",
- "memberOf" : ""
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "bgcolor",
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "blankText",
"type" : "String",
- "desc" : "Specifies the background color of a cell",
- "memberOf" : ""
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "can_build_overlaid",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "charoff",
- "type" : "Number",
- "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
- "memberOf" : ""
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
- "desc" : "cell class",
- "memberOf" : ""
- },
- {
- "name" : "colspan",
- "type" : "Number",
- "desc" : "Specifies the number of columns a cell should span",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "headers",
- "type" : "String",
- "desc" : "Specifies one or more header cells a cell is related to",
- "memberOf" : ""
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "Sets the height of a cell",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "errors",
+ "type" : "String/Object",
+ "desc" : "A Error spec, or true for a default spec (defaults to\n{\n PwdEmpty: \"Please type a password, and then retype it to confirm.\",\n PwdShort: \"Your password must be at least 6 characters long. Please type a different password.\",\n PwdLong: \"Your password can't contain more than 16 characters. Please type a different password.\",\n PwdBadChar: \"The password contains characters that aren't allowed. Please type a different password.\",\n IDInPwd: \"Your password can't include the part of your ID. Please type a different password.\",\n FNInPwd: \"Your password can't contain your first name. Please type a different password.\",\n LNInPwd: \"Your password can't contain your last name. Please type a different password.\"\n})",
"memberOf" : ""
},
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "html",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "cell contain text",
- "memberOf" : ""
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "nowrap",
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "maxLengthText",
"type" : "String",
- "desc" : "Specifies that the content inside a cell should not wrap",
- "memberOf" : ""
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "rowspan",
+ "name" : "md",
"type" : "Number",
- "desc" : "Sets the number of rows a cell should span",
- "memberOf" : ""
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "scope",
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLengthText",
"type" : "String",
- "desc" : "Defines a way to associate header cells and data cells in a table",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "pwdStrengths",
+ "type" : "String/Object",
+ "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
"memberOf" : ""
},
{
- "name" : "style",
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tag",
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "style",
"type" : "String",
- "desc" : "cell tag (td|th) default td",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "valign",
+ "name" : "validClass",
"type" : "String",
- "desc" : "Vertical aligns the content in a cell",
- "memberOf" : ""
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "Specifies the width of a cell",
- "memberOf" : ""
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "childrenrendered",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "render",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.TableRow" : {
+ "Roo.bootstrap.Slider" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "Aligns the content in a table row",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "bgcolor",
- "type" : "String",
- "desc" : "Specifies a background color for a table row",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "charoff",
- "type" : "Number",
- "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "row class",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "valign",
- "type" : "String",
- "desc" : "Vertical aligns the content in a table row",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
]
},
- "Roo.bootstrap.TextArea" : {
+ "Roo.bootstrap.SplitBar" : {
"props" : [
{
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
- },
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ }
+ ],
+ "events" : [
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "beforeresize",
+ "type" : "function",
+ "desc" : "Fires before the splitter is dragged",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "moved",
+ "type" : "function",
+ "desc" : "Fires when the splitter is moved",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : ""
+ }
+ ],
+ "methods" : [
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "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"
},
{
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroy this splitbar.",
+ "sig" : "(removeEl)",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "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"
},
{
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "getAdapter",
+ "type" : "function",
+ "desc" : "Get the adapter this SplitBar uses",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "getMaximumSize",
+ "type" : "function",
+ "desc" : "Gets the maximum size for the resizing element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "cols",
- "type" : "Number",
- "desc" : "Specifies the visible width of a text area",
+ "name" : "getMinimumSize",
+ "type" : "function",
+ "desc" : "Gets the minimum size for the resizing element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "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"
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "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"
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "setAdapter",
+ "type" : "function",
+ "desc" : "Set the adapter this SplitBar uses",
+ "sig" : "(adapter)",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "setCurrentSize",
+ "type" : "function",
+ "desc" : "Sets the initialize size for the resizing element",
+ "sig" : "(size)",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "setMaximumSize",
+ "type" : "function",
+ "desc" : "Sets the maximum size for the resizing element",
+ "sig" : "(maxSize)",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "setMinimumSize",
+ "type" : "function",
+ "desc" : "Sets the minimum size for the resizing element",
+ "sig" : "(minSize)",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "html",
- "type" : "string",
- "desc" : "text",
- "memberOf" : ""
+ "name" : "getElementSize",
+ "type" : "function",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "setElementSize",
+ "type" : "function",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter"
+ }
+ ]
+ },
+ "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "getElementSize",
+ "type" : "function",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
+ "name" : "setElementSize",
+ "type" : "function",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.bootstrap.TabGroup" : {
+ "props" : [
{
- "name" : "invalidFeedbackIcon",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "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" : "invalidText",
+ "name" : "alert",
"type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "r) type alert (changes background / border...)",
+ "memberOf" : "Roo.bootstrap.Column",
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "autoslide",
+ "type" : "Boolean",
+ "desc" : "e) auto slide .. default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "bullets",
+ "type" : "Boolean",
+ "desc" : "show bullets for the panels",
+ "memberOf" : ""
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "carousel",
+ "type" : "Boolean",
+ "desc" : "true to make the group behave like a carousel",
+ "memberOf" : ""
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "maskRe",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "maxLengthText",
+ "name" : "fa",
"type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : ".) font awesome icon",
+ "memberOf" : "Roo.bootstrap.Column",
+ "optvals" : [
+ "ban",
+ "check",
+ "..."
+ ]
},
{
- "name" : "md",
+ "name" : "fasize",
"type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : ".) font awsome size",
+ "memberOf" : "Roo.bootstrap.Column",
+ "optvals" : [
+ "1",
+ "2",
+ "...."
+ ]
},
{
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "e) hide the element",
+ "memberOf" : "Roo.bootstrap.Column",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "minLengthText",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "name",
+ "name" : "html",
"type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "content of column.",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "regexText",
+ "name" : "icon",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "resize",
- "type" : "string",
- "desc" : [
- "(none",
- "both",
- "horizontal",
- "vertical",
- "inherit",
- "initial)"
- ],
- "memberOf" : ""
+ "desc" : ".) glyphicon name",
+ "memberOf" : "Roo.bootstrap.Column",
+ "optvals" : [
+ "info-sign",
+ "check",
+ "..."
+ ]
},
{
- "name" : "rows",
+ "name" : "lg",
"type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : ""
+ "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "lgoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "sm",
+ "name" : "md",
"type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "mdoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "tooltip",
+ "name" : "name",
"type" : "string",
- "desc" : "Text for the tooltip",
+ "desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "validClass",
+ "name" : "navId",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
+ "memberOf" : ""
},
{
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "showarrow",
+ "type" : "Boolean",
+ "desc" : "e) show arrow default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "validationDelay",
+ "name" : "smoff",
"type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "timer",
+ "type" : "Number",
+ "desc" : "auto slide timer .. default 0 millisecond",
+ "memberOf" : ""
},
{
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "wrap",
- "type" : "string",
- "desc" : [
- "(soft",
- "hard)"
- ],
- "memberOf" : ""
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
{
"name" : "xs",
"type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "xsoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
}
],
"events" : [
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "childrenrendered",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "focus",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "render",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
+ },
{
"name" : "getChildContainer",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real textarea element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : ""
+ },
{
"name" : "releaseCapture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "show a specific panel",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "tooltipEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.TimeField" : {
+ "Roo.bootstrap.TabPanel" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : [
- "(left",
- "center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "panel active",
+ "memberOf" : ""
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "format",
- "type" : "String",
- "desc" : "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').",
- "memberOf" : ""
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "invalidText",
+ "name" : "href",
"type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "click to link..",
+ "memberOf" : ""
},
{
- "name" : "labelAlign",
+ "name" : "html",
"type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "panel content",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "regexText",
+ "name" : "navId",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "The Roo.bootstrap.NavGroup which triggers show hide ()",
+ "memberOf" : ""
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
+ "name" : "tabId",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
+ "memberOf" : ""
},
{
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
+ {
+ "name" : "beforedeactivate",
+ "type" : "function",
+ "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforedestroy",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "change",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when the active status changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "childrenrendered",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "render",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "select",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (thisthis, date)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- }
- ]
- },
- "Roo.bootstrap.Tooltip" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "currentEl",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : true,
- "memberOf" : ""
}
]
},
- "Roo.bootstrap.TriggerField" : {
+ "Roo.bootstrap.Table" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : [
- "(image",
- "video",
- "audio)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "align",
"type" : "String",
- "desc" : [
- "(left",
+ "desc" : "t) Specifies the alignment of a table according to surrounding text",
+ "memberOf" : "",
+ "optvals" : [
+ "left",
"center",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "right"
+ ]
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "autocomplete",
+ "name" : "auto_hide_footer",
+ "type" : "Boolean",
+ "desc" : "auto hide footer if only one page (default false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "bgcolor",
"type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies the background color for a table",
+ "memberOf" : ""
},
{
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "border",
+ "type" : "Number",
+ "desc" : "Specifies whether the table cells should have borders or not",
+ "memberOf" : ""
},
{
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "bordered",
+ "type" : "boolean",
+ "desc" : "Add borders to the table",
+ "memberOf" : ""
},
{
"name" : "can_build_overlaid",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "capture",
- "type" : "String",
- "desc" : [
- "(user",
- "camera)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "cellSelection",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "caret",
- "type" : "String",
- "desc" : [
- "(search",
- "calendar)"
- ],
+ "name" : "cellpadding",
+ "type" : "Number",
+ "desc" : "Specifies the space between the cell wall and the cell content",
+ "memberOf" : ""
+ },
+ {
+ "name" : "cellspacing",
+ "type" : "Number",
+ "desc" : "Specifies the space between cells",
"memberOf" : ""
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "table class",
+ "memberOf" : ""
+ },
+ {
+ "name" : "condensed",
+ "type" : "boolean",
+ "desc" : "Format condensed",
+ "memberOf" : ""
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "footer",
+ "type" : "Roo.bootstrap.PagingToolbar",
+ "desc" : "a paging toolbar",
+ "memberOf" : ""
},
{
- "name" : "disabled",
+ "name" : "footerShow",
"type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) generate tfoot, default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "focusClass",
+ "name" : "frame",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies which parts of the outside borders that should be visible",
+ "memberOf" : ""
},
{
- "name" : "hasFeedback",
+ "name" : "headerShow",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) generate thead, default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "name" : "hover",
+ "type" : "boolean",
+ "desc" : "Add hover highlighting",
"memberOf" : ""
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : [
- "(left",
- "right)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelAlign",
+ "name" : "layout",
"type" : "String",
- "desc" : [
- "(top",
- "left)"
- ],
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "table layout (auto | fixed | initial | inherit)",
+ "memberOf" : ""
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "lazyLoad",
+ "type" : "Boolean",
+ "desc" : "auto load data while scrolling to the end (default false)",
+ "memberOf" : ""
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "responsive",
+ "type" : "boolean",
+ "desc" : "Format condensed",
+ "memberOf" : ""
},
{
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "rowSelection",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "regexText",
+ "name" : "rules",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "Specifies which parts of the inside borders that should be visible",
"memberOf" : ""
},
{
- "name" : "selectOnFocus",
+ "name" : "scrollBody",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "e) default false - body scrolled / fixed header",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "sortable",
+ "type" : "String",
+ "desc" : "Specifies that the table should be sortable",
+ "memberOf" : ""
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "striped",
+ "type" : "boolean",
+ "desc" : "Should the rows be alternative striped",
+ "memberOf" : ""
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "triggerClass",
+ "name" : "summary",
"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.",
+ "desc" : "Specifies a summary of the content of a table",
"memberOf" : ""
},
{
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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.Input"
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "Specifies the width of a table",
+ "memberOf" : ""
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"memberOf" : "Roo.Component"
},
{
- "name" : "blur",
+ "name" : "cellclick",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "change",
+ "name" : "cellcontextmenu",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "celldblclick",
+ "type" : "function",
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "childrenrendered",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "contextmenu",
+ "type" : "function",
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "focus",
+ "name" : "headercontextmenu",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "hide",
"memberOf" : "Roo.Component"
},
{
- "name" : "invalid",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when a mouseout occur",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "keyup",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when a mouseover occur",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "render",
"memberOf" : "Roo.Component"
},
{
- "name" : "show",
+ "name" : "rowclass",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (_self, rowcfg)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "specialkey",
+ "name" : "rowclick",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "valid",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "rowdblclick",
+ "type" : "function",
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "rowsrendered",
+ "type" : "function",
+ "desc" : "Fires when all the rows have been rendered",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : ""
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
{
"name" : "autoSize",
"type" : "function",
- "desc" : "",
+ "desc" : "Forces a resize - used by panel.Grid",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "clearInvalid",
+ "name" : "clear",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Remove all rows",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : ""
},
{
"name" : "destroy",
"memberOf" : "Roo.Component"
},
{
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "getRawValue",
+ "name" : "getGridEl",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "desc" : "Returns the grid's underlying element = used by panel.Grid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : ""
},
{
- "name" : "getValue",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.Component"
},
{
"name" : "getVisibilityEl",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "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" : ""
- },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "setDisabled",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "setValue",
+ "name" : "setRowVisibility",
"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" : "Show or hide a row.",
+ "sig" : "(rowIndex, state)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : ""
},
{
"name" : "setVisibilityEl",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
+ }
+ ]
+ },
+ "Roo.bootstrap.Table.AbstractSelectionModel" : {
+ "props" : [
{
- "name" : "validate",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "validateValue",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input"
- }
- ]
- },
- "Roo.bootstrap.UploadCropbox" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "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"
},
{
- "name" : "buttons",
- "type" : "Array",
- "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
- "memberOf" : ""
+ "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"
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "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"
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "isLocked",
+ "type" : "function",
+ "desc" : "Returns true if the selections are locked.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Locks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "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"
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "emptyText",
- "type" : "String",
- "desc" : "show when image has been loaded",
- "memberOf" : ""
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "errorTimeout",
- "type" : "Number",
- "desc" : "default 3000",
- "memberOf" : ""
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "isDocument",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlocks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : ""
- },
+ }
+ ]
+ },
+ "Roo.bootstrap.Table.RowSelectionModel" : {
+ "props" : [
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "loadMask",
+ "name" : "singleSelect",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "True to allow selection of only one row at a time (defaults to false)",
"memberOf" : ""
- },
+ }
+ ],
+ "events" : [
{
- "name" : "loadingText",
- "type" : "Boolean",
- "desc" : "default 'Loading...'",
+ "name" : "afterselectionchange",
+ "type" : "function",
+ "desc" : "Fires after the selection changes (eg. by key press or clicking)",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "method",
- "type" : "String",
- "desc" : "default POST",
+ "name" : "beforerowselect",
+ "type" : "function",
+ "desc" : "Fires when a row is selected being selected, return false to cancel.",
+ "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "minHeight",
- "type" : "Number",
- "desc" : "default 300",
+ "name" : "rowdeselect",
+ "type" : "function",
+ "desc" : "Fires when a row is deselected.",
+ "sig" : "function (_self, rowIndex)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "default 300",
+ "name" : "rowselect",
+ "type" : "function",
+ "desc" : "Fires when a row is selected.",
+ "sig" : "function (_self, rowIndex, r)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "paramName",
- "type" : "String",
- "desc" : "default 'imageUpload'",
+ "name" : "selectionchange",
+ "type" : "function",
+ "desc" : "Fires when the selection changes",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "rotateNotify",
- "type" : "String",
- "desc" : "show when image too small to rotate",
- "memberOf" : ""
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "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"
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "action url",
+ "name" : "clearSelections",
+ "type" : "function",
+ "desc" : "Clears all selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "arrange",
+ "name" : "deselectRange",
"type" : "function",
- "desc" : "Fire when arrange the file data",
- "sig" : "function (_self, formData)\n{\n\n}",
+ "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
+ "sig" : "(startRow, endRow)",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "beforedestroy",
+ "name" : "deselectRow",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Deselects a row.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "beforehide",
+ "name" : "fireEvent",
"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 the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "beforeloadcanvas",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Fire before load the canvas",
- "sig" : "function (_self, src)\n{\n\n}",
+ "desc" : "Gets the number of selected rows.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "beforerender",
+ "name" : "getSelected",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Returns the first selected record.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "beforeselectfile",
+ "name" : "getSelections",
"type" : "function",
- "desc" : "Fire before select file",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Returns the selected records",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "beforeshow",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "childrenrendered",
+ "name" : "hasSelection",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "Returns True if there is a selection.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "crop",
+ "name" : "isIdSelected",
"type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self, data)\n{\n\n}",
+ "desc" : "Returns True if the specified record id is selected.",
+ "sig" : "(id)",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "destroy",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Returns true if the selections are locked.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel"
},
{
- "name" : "disable",
+ "name" : "isSelected",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Returns True if the specified row is selected.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "download",
+ "name" : "lock",
"type" : "function",
- "desc" : "Fire when download the image",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Locks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel"
},
{
- "name" : "enable",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "exception",
- "type" : "function",
- "desc" : "Fire when get exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "footerbuttonclick",
- "type" : "function",
- "desc" : "Fire when footerbuttonclick",
- "sig" : "function (_self, type)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "initial",
- "type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "inspect",
- "type" : "function",
- "desc" : "Fire when inspect the file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "prepare",
- "type" : "function",
- "desc" : "Fire when preparing the file data",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fire when resize",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "rotate",
- "type" : "function",
- "desc" : "Fire when rotate the image",
- "sig" : "function (_self, pos)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "trash",
- "type" : "function",
- "desc" : "Fire when trash image",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "upload",
- "type" : "function",
- "desc" : "Fire when xhr upload the file",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : ""
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addListener",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "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"
},
{
- "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"
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "fireEvent",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "getEl",
+ "name" : "selectAll",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Selects all rows.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "getId",
+ "name" : "selectFirstRow",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Selects the first row in the grid.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "getVisibilityEl",
+ "name" : "selectLastRow",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Select the last row.",
+ "sig" : "(keepExisting)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
- "name" : "hasListener",
+ "name" : "selectNext",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Selects the row immediately following the last selected row.",
+ "sig" : "(keepExisting)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
},
{
- "name" : "hide",
+ "name" : "selectPrevious",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Selects the row that precedes the last selected row.",
+ "sig" : "(keepExisting)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
- "name" : "initEvents",
+ "name" : "selectRange",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
+ "sig" : "(startRow, endRow, keepExisting)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : ""
},
{
- "name" : "isVisible",
+ "name" : "selectRecords",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Select records.",
+ "sig" : "(records, keepExisting)",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "on",
+ "name" : "selectRow",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Selects a row.",
+ "sig" : "(row, keepExisting)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
},
{
- "name" : "purgeListeners",
+ "name" : "selectRows",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Selects multiple rows.",
+ "sig" : "(rows, keepExisting)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
},
{
- "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"
},
{
- "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"
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tooltipEl",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
+ "desc" : "Unlocks the selections.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.bootstrap.Table.AbstractSelectionModel"
}
]
},
- "Roo.bootstrap.dash" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
- },
- "Roo.bootstrap.dash.NumberBox" : {
+ "Roo.bootstrap.TableBody" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "Aligns the content inside the element",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "charoff",
+ "type" : "Number",
+ "desc" : "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute",
+ "memberOf" : ""
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "element class",
+ "memberOf" : ""
},
{
"name" : "container_method",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Box content",
- "memberOf" : ""
- },
{
"name" : "dataId",
"type" : "string",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "fhref",
- "type" : "String",
- "desc" : "Footer href",
- "memberOf" : ""
- },
- {
- "name" : "footer",
- "type" : "String",
- "desc" : "Footer text",
- "memberOf" : ""
- },
- {
- "name" : "headline",
- "type" : "String",
- "desc" : "Box headline",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : "Box icon",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "element tag (thead|tbody|tfoot) default tbody",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "valign",
+ "type" : "String",
+ "desc" : "Vertical aligns the content inside the <tbody> element",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
]
},
- "Roo.bootstrap.dash.TabBox" : {
+ "Roo.bootstrap.TableCell" : {
"props" : [
+ {
+ "name" : "abbr",
+ "type" : "String",
+ "desc" : "Specifies an abbreviated version of the content in a cell",
+ "memberOf" : ""
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "Aligns the content in a cell",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "axis",
+ "type" : "String",
+ "desc" : "Categorizes cells",
+ "memberOf" : ""
+ },
+ {
+ "name" : "bgcolor",
+ "type" : "String",
+ "desc" : "Specifies the background color of a cell",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "charoff",
+ "type" : "Number",
+ "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
+ "memberOf" : ""
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "cell class",
+ "memberOf" : ""
+ },
+ {
+ "name" : "colspan",
+ "type" : "Number",
+ "desc" : "Specifies the number of columns a cell should span",
+ "memberOf" : ""
},
{
"name" : "container_method",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "headers",
+ "type" : "String",
+ "desc" : "Specifies one or more header cells a cell is related to",
+ "memberOf" : ""
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "Sets the height of a cell",
+ "memberOf" : ""
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "icon",
+ "name" : "html",
"type" : "String",
- "desc" : "Icon of the TabBox",
+ "desc" : "cell contain text",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "showtabs",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "name" : "nowrap",
+ "type" : "String",
+ "desc" : "Specifies that the content inside a cell should not wrap",
+ "memberOf" : ""
+ },
+ {
+ "name" : "rowspan",
+ "type" : "Number",
+ "desc" : "Sets the number of rows a cell should span",
+ "memberOf" : ""
+ },
+ {
+ "name" : "scope",
+ "type" : "String",
+ "desc" : "Defines a way to associate header cells and data cells in a table",
"memberOf" : ""
},
{
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tabScrollable",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "title",
+ "name" : "tag",
"type" : "String",
- "desc" : "Title of the TabBox",
+ "desc" : "cell tag (td|th) default td",
"memberOf" : ""
},
{
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "valign",
+ "type" : "String",
+ "desc" : "Vertical aligns the content in a cell",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "Specifies the width of a cell",
+ "memberOf" : ""
},
{
"name" : "xattr",
}
],
"events" : [
- {
- "name" : "activatepane",
- "type" : "function",
- "desc" : "When a pane is activated",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "addpane",
- "type" : "function",
- "desc" : "When a pane is added",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforedestroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "Updates the box title",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.dash.TabPane" : {
+ "Roo.bootstrap.TableRow" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : [
- "(false",
- "true)"
- ],
+ "name" : "align",
+ "type" : "String",
+ "desc" : "Aligns the content in a table row",
"memberOf" : ""
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "bgcolor",
+ "type" : "String",
+ "desc" : "Specifies a background color for a table row",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "charoff",
+ "type" : "Number",
+ "desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
+ "memberOf" : ""
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "row class",
+ "memberOf" : ""
},
{
"name" : "container_method",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "title of panel",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "valign",
+ "type" : "String",
+ "desc" : "Vertical aligns the content in a table row",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
],
"events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "When a pane is activated",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforedestroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "Updates the tab title",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.htmleditor" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
- },
- "Roo.bootstrap.htmleditor.ToolbarStandard" : {
+ "Roo.bootstrap.TextArea" : {
"props" : [
{
- "name" : "btns",
- "type" : "Array",
- "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
- "memberOf" : ""
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
- "name" : "disable",
- "type" : "Object",
- "desc" : "List of elements to disable..",
- "memberOf" : ""
- }
- ],
- "events" : [
- ],
- "methods" : [
+ "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" : "updateToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.bootstrap.layout" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
- },
- "Roo.bootstrap.layout.Basic" : {
- "props" : [
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : ""
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "region",
- "type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : ""
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : ""
- }
- ],
- "events" : [
- ],
- "methods" : [
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
- "name" : "add",
- "type" : "function",
- "desc" : "Add the passed ContentPanel(s)",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : ""
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"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"
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
- "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"
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "getActivePanel",
- "type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "cols",
+ "type" : "Number",
+ "desc" : "Specifies the visible width of a text area",
"memberOf" : ""
},
{
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the container element for this region.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "getPanel",
- "type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : ""
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "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"
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hasPanel",
- "type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : ""
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this region is currently visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "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,
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
"memberOf" : ""
},
{
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "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" : ""
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "showPanel",
- "type" : "function",
- "desc" : "Show the specified panel.",
- "sig" : "(panelId)",
- "static" : false,
- "memberOf" : ""
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.bootstrap.layout.Border" : {
- "props" : [
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
- "name" : "actionMode",
+ "name" : "invalidText",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "style",
+ "name" : "maskRe",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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"
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "resize",
+ "type" : "string",
+ "desc" : "l)",
+ "memberOf" : "",
+ "optvals" : [
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
+ ]
+ },
+ {
+ "name" : "rows",
+ "type" : "Number",
+ "desc" : "Specifies the visible number of lines in a text area",
+ "memberOf" : ""
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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.Input"
+ },
+ {
+ "name" : "wrap",
+ "type" : "string",
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form",
+ "memberOf" : "",
+ "optvals" : [
+ "soft",
+ "hard"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
{
- "name" : "layout",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "regioncollapsed",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager"
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "regionexpanded",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager"
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "regionresized",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager"
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "render",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Adds a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
- "static" : false,
- "memberOf" : ""
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "addRegion",
- "type" : "function",
- "desc" : "Creates and adds a new region if it doesn't already exist.",
- "sig" : "(target, config)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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" : ""
- },
- {
- "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"
- },
{
"name" : "capture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "endUpdate",
- "type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager"
- },
- {
- "name" : "findPanel",
- "type" : "function",
- "desc" : "Searches all regions for a panel with the specified id",
- "sig" : "(panelId)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager"
+ "memberOf" : "Roo.Component"
},
{
"name" : "getId",
"memberOf" : "Roo.Component"
},
{
- "name" : "getRegion",
+ "name" : "getName",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager"
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getViewSize",
+ "name" : "getRawValue",
"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 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.layout.Manager"
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "getVisibilityEl",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "isUpdating",
+ "name" : "inputEl",
"type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
+ "desc" : "return the real textarea element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager"
+ "memberOf" : ""
},
{
"name" : "isVisible",
"memberOf" : "Roo.Component"
},
{
- "name" : "layout",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Performs a layout update.",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Remove a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "removeListener",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "showPanel",
- "type" : "function",
- "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
- "sig" : "(panelId)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "tooltipEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.layout.Manager" : {
+ "Roo.bootstrap.TimeField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
+ },
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
{
"name" : "cls",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "name",
+ "name" : "fieldLabel",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "style",
+ "name" : "focusClass",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "format",
+ "type" : "String",
+ "desc" : "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').",
+ "memberOf" : ""
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "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"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "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"
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "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"
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "childrenrendered",
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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.Input"
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "childrenrendered",
"type" : "function",
"desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "hide",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "layout",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "regioncollapsed",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "regionexpanded",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "regionresized",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
+ "desc" : "Fires when this field show.",
+ "sig" : "function (thisthis, date)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "render",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "show",
+ "name" : "valid",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "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" : ""
- },
{
"name" : "capture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "endUpdate",
- "type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "getId",
"memberOf" : "Roo.Component"
},
{
- "name" : "getRegion",
+ "name" : "getName",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getViewSize",
+ "name" : "getRawValue",
"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 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" : ""
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "getVisibilityEl",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "isUpdating",
+ "name" : "inputEl",
"type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
+ "desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "isVisible",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.layout.Region" : {
- "props" : [
+ "Roo.bootstrap.Tooltip" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "name" : "currentEl",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
"memberOf" : ""
+ }
+ ]
+ },
+ "Roo.bootstrap.TriggerField" : {
+ "props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to animate expand/collapse (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"
},
{
- "name" : "autoHide",
- "type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : ""
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "autoScroll",
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ {
+ "name" : "allowBlank",
"type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : ""
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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" : ""
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "cls",
- "type" : "string",
- "desc" : "Extra CSS classes to add to region",
- "memberOf" : ""
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : ""
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : ""
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : ""
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : ""
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "",
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
},
{
- "name" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : ""
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : ""
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : ""
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : ""
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "overflow",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "focusClass",
"type" : "String",
- "desc" : [
- "(hidden",
- "visible)"
- ],
- "memberOf" : ""
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : ""
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "preservePanels",
+ "name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : ""
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "region",
- "type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "resizeTabs",
+ "name" : "hideTrigger",
"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)",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
"memberOf" : ""
},
{
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : "Roo.bootstrap.layout.Basic"
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : ""
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "button | checkbox | email | file | hidden | image | number | password | radio | range | reset | search | submit | text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "tabPosition",
+ "name" : "invalidClass",
"type" : "String",
- "desc" : [
- "(top",
- "bottom)"
- ],
- "memberOf" : ""
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "title",
+ "name" : "invalidFeedbackIcon",
"type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : ""
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : ""
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : ""
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Input",
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
- "name" : "width",
+ "name" : "labelWidth",
"type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : ""
- }
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : ""
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "animateCollapse",
- "type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
- "static" : false,
- "memberOf" : ""
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "animateExpand",
- "type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
- "static" : false,
- "memberOf" : ""
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : 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"
},
{
- "name" : "getActivePanel",
- "type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getBox",
- "type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
- "static" : false,
- "memberOf" : ""
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the container element for this region.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "maxLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getPanel",
- "type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic"
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic"
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getTabs",
- "type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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"
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hasPanel",
- "type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic"
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides this region.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "hidePanel",
- "type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : ""
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this region is currently visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "regex",
+ "type" : "RegExp",
+ "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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"
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "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" : ""
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "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" : "Roo.bootstrap.layout.Basic"
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "showPanel",
- "type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
- "static" : false,
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
"memberOf" : ""
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "unhidePanel",
- "type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.bootstrap.layout.Split" : {
- "props" : [
- {
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "animate",
+ "name" : "validateOnBlur",
"type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "autoHide",
- "type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "closeOnTab",
- "type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "cmargins",
- "type" : "Object",
- "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "collapsed",
- "type" : "Boolean",
- "desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "collapsedTitle",
+ "name" : "vtype",
"type" : "String",
- "desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "collapsible",
- "type" : "Boolean",
- "desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.LayoutRegion"
- },
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.Input"
+ }
+ ],
+ "events" : [
{
- "name" : "floatable",
- "type" : "Boolean",
- "desc" : "False to disable floating (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "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"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "listeners",
- "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" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "resizeTabs",
- "type" : "Boolean",
- "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "showPin",
- "type" : "Boolean",
- "desc" : "True to show a pin button",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "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"
},
{
- "name" : "tabPosition",
- "type" : "String",
- "desc" : [
- "(top",
- "bottom)"
- ],
- "memberOf" : "Roo.LayoutRegion"
+ "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"
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.LayoutRegion"
+ "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"
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : "Roo.LayoutRegion"
- }
- ],
- "events" : [
- {
- "name" : "beforecollapse",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when this region before collapse.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "beforeremove",
+ "name" : "destroy",
"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 after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "collapsed",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when this region is collapsed.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "expanded",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when this region is expanded.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "invalidated",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires when the layout for this region is changed.",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "panelactivated",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a panel is activated.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "paneladded",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fires when a panel is added.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "panelremoved",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fires when a panel is removed.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "resized",
+ "name" : "render",
"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 rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "slidehide",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when this region slides out of view.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "slideshow",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Fires when this region is slid into view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "visibilitychange",
+ "name" : "valid",
"type" : "function",
- "desc" : "Fires when this region is shown or hidden",
- "sig" : "function (_self, visibility)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion"
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Input"
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion"
- },
{
"name" : "addEvents",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "capture",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "collapse",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "expand",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
"name" : "fireEvent",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getPanel",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getPosition",
+ "name" : "getName",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion"
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getSplitBar",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Returns the {@link Roo.SplitBar} for this region.",
+ "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" : ""
+ "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "getTabs",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "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.LayoutRegion"
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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"
},
{
"name" : "hasListener",
"memberOf" : "Roo.util.Observable"
},
{
- "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.BasicLayoutRegion"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "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"
},
{
- "name" : "hidePanel",
+ "name" : "inputEl",
"type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"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"
+ },
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "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" : ""
+ },
{
"name" : "purgeListeners",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "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"
- },
{
"name" : "removeListener",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "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"
},
{
- "name" : "setCollapsedTitle",
+ "name" : "reset",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
"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" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "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" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "un",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "unhidePanel",
+ "name" : "validate",
"type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.bootstrap.Input"
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Input"
}
]
},
- "Roo.bootstrap.menu" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
- },
- "Roo.bootstrap.menu.Item" : {
+ "Roo.bootstrap.UploadCropbox" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "memberOf" : ""
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "disable",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideMode",
+ "name" : "emptyText",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "show when image has been loaded",
+ "memberOf" : ""
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
"memberOf" : ""
},
{
- "name" : "html",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "text of the item",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "Font awesome icon",
- "memberOf" : ""
+ "name" : "isDocument",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "pos",
- "type" : "String",
- "desc" : "Submenu align to (left | right) default right",
- "memberOf" : ""
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "preventDefault",
+ "name" : "loadingText",
"type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "default 'Loading...'",
"memberOf" : ""
},
{
- "name" : "style",
+ "name" : "method",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "submenu",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "default POST",
"memberOf" : ""
},
{
- "name" : "tooltip",
+ "name" : "minHeight",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : ""
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "paramName",
+ "type" : "String",
+ "desc" : "default 'imageUpload'",
+ "memberOf" : ""
+ },
+ {
+ "name" : "rotateNotify",
+ "type" : "String",
+ "desc" : "show when image too small to rotate",
+ "memberOf" : ""
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "action url",
+ "memberOf" : ""
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
],
"events" : [
+ {
+ "name" : "arrange",
+ "type" : "function",
+ "desc" : "Fire when arrange the file data",
+ "sig" : "function (_self, formData)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforeloadcanvas",
+ "type" : "function",
+ "desc" : "Fire before load the canvas",
+ "sig" : "function (_self, src)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforerender",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforeselectfile",
+ "type" : "function",
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforeshow",
"type" : "function",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "click",
+ "name" : "crop",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self, data)\n{\n\n}",
"memberOf" : ""
},
{
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "download",
+ "type" : "function",
+ "desc" : "Fire when download the image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "enable",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "exception",
+ "type" : "function",
+ "desc" : "Fire when get exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "footerbuttonclick",
+ "type" : "function",
+ "desc" : "Fire when footerbuttonclick",
+ "sig" : "function (_self, type)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "hide",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "mouseout",
+ "name" : "initial",
"type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "mouseover",
+ "name" : "inspect",
"type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fire when inspect the file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "prepare",
+ "type" : "function",
+ "desc" : "Fire when preparing the file data",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : ""
},
{
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fire when resize",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "rotate",
+ "type" : "function",
+ "desc" : "Fire when rotate the image",
+ "sig" : "function (_self, pos)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "show",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "trash",
+ "type" : "function",
+ "desc" : "Fire when trash image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "upload",
+ "type" : "function",
+ "desc" : "Fire when xhr upload the file",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : ""
}
],
"methods" : [
}
]
},
- "Roo.bootstrap.menu.Menu" : {
+ "Roo.bootstrap.dash" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.dash.NumberBox" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "content",
+ "type" : "String",
+ "desc" : "Box content",
+ "memberOf" : ""
+ },
{
"name" : "dataId",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideMode",
+ "name" : "fhref",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "Footer href",
+ "memberOf" : ""
},
{
- "name" : "html",
+ "name" : "footer",
"type" : "String",
- "desc" : "Text of the menu",
+ "desc" : "Footer text",
"memberOf" : ""
},
+ {
+ "name" : "headline",
+ "type" : "String",
+ "desc" : "Box headline",
+ "memberOf" : ""
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
{
"name" : "icon",
"type" : "String",
- "desc" : "Font awesome icon",
+ "desc" : "Box icon",
"memberOf" : ""
},
{
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "pos",
- "type" : "String",
- "desc" : "Menu align to (top | bottom) default bottom",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : [
- "(default",
- "primary",
- "success",
- "info",
- "warning",
- "danger",
- "inverse)"
- ],
- "memberOf" : ""
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before this menu is hidden",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "beforerender",
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before this menu is displayed",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "childrenrendered",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "render",
{
"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"
}
],
"methods" : [
}
]
},
- "Roo.bootstrap.menu.Separator" : {
+ "Roo.bootstrap.dash.TabBox" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "Icon of the TabBox",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "showtabs",
+ "type" : "Boolean",
+ "desc" : "e) show the tabs default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tabScrollable",
+ "type" : "Boolean",
+ "desc" : "e) tab scrollable when mobile view default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "Title of the TabBox",
+ "memberOf" : ""
+ },
{
"name" : "tooltip",
"type" : "string",
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : [
- "(el",
- "parent)"
- ],
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
}
],
"events" : [
+ {
+ "name" : "activatepane",
+ "type" : "function",
+ "desc" : "When a pane is activated",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "addpane",
+ "type" : "function",
+ "desc" : "When a pane is added",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforedestroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "Updates the box title",
+ "sig" : "(html)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
]
},
- "Roo.bootstrap.panel" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
- },
- "Roo.bootstrap.panel.Content" : {
+ "Roo.bootstrap.dash.TabPane" : {
"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" : ""
+ "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" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : ""
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "",
+ "optvals" : [
+ "false",
+ "true"
+ ]
},
{
- "name" : "autoScroll",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : ""
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "background",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : ""
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : ""
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "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" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "region",
+ "name" : "style",
"type" : "String",
- "desc" : [
- "(center",
- "north",
- "south",
- "east",
- "west)"
- ],
- "memberOf" : ""
- },
- {
- "name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "title",
"type" : "String",
- "desc" : "The title for this panel",
+ "desc" : "title of panel",
"memberOf" : ""
},
{
- "name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : ""
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
}
],
"events" : [
{
"name" : "activate",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "When a pane is activated",
+ "sig" : "function (pane)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "deactivate",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
"name" : "render",
"type" : "function",
- "desc" : "Fires when this tab is created",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "resize",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this panel",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "fireEvent",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getChildContainer",
+ "name" : "enable",
"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" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getEl",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "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"
},
{
- "name" : "getId",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns this panel's id",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "getTitle",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns this panel's title",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getToolbar",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getUpdateManager",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "hasListener",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "isClosable",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "load",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "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" : ""
- },
{
"name" : "releaseCapture",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "setContent",
+ "name" : "render",
"type" : "function",
- "desc" : "Updates this panel's element",
- "sig" : "(content, loadScripts)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
"name" : "setTitle",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Updates the tab title",
+ "sig" : "(html)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "setUrl",
+ "name" : "setVisibilityEl",
"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" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "un",
}
]
},
- "Roo.bootstrap.panel.Grid" : {
+ "Roo.bootstrap.htmleditor" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.htmleditor.ToolbarStandard" : {
"props" : [
{
- "name" : "adjustments",
+ "name" : "btns",
"type" : "Array",
- "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "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"
+ "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "memberOf" : ""
},
{
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
+ "name" : "disable",
+ "type" : "Object",
+ "desc" : "List of elements to disable..",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
{
- "name" : "grid",
- "type" : "Roo.bootstrap.Table",
- "desc" : "The grid for this panel",
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : ""
- },
+ }
+ ]
+ },
+ "Roo.bootstrap.layout" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.layout.Basic" : {
+ "props" : [
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : ""
},
{
"name" : "region",
- "type" : "String",
- "desc" : [
- "(center",
- "north",
- "south",
- "east",
- "west)"
- ],
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "memberOf" : ""
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : ""
}
],
- "events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "deactivate",
- "type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
+ "events" : [],
+ "methods" : [
{
- "name" : "render",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when this tab is created",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "Add the passed ContentPanel(s)",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : ""
},
- {
- "name" : "resize",
- "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"
- }
- ],
- "methods" : [
{
"name" : "addEvents",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this panel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
{
"name" : "fireEvent",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "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"
- },
- {
- "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"
- },
- {
- "name" : "getGrid",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Returns the grid for this panel",
+ "desc" : "Get the active panel for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "getTitle",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns this panel's title",
+ "desc" : "Returns the container element for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : ""
},
{
- "name" : "getToolbar",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : ""
},
{
- "name" : "getUpdateManager",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : ""
},
{
"name" : "hasListener",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "isClosable",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : ""
},
{
- "name" : "load",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Returns true if this region is currently visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : ""
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "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"
- },
{
"name" : "releaseCapture",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "removeListener",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
},
{
- "name" : "setContent",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Updates this panel's element",
- "sig" : "(content, loadScripts)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "setTitle",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : ""
},
{
- "name" : "setUrl",
+ "name" : "showPanel",
"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" : "Show the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : ""
},
{
"name" : "un",
}
]
},
- "Roo.bootstrap.panel.Nest" : {
+ "Roo.bootstrap.layout.Border" : {
"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"
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "name" : "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" : "autoScroll",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "background",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "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"
+ "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"
+ "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"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "region",
+ "name" : "style",
"type" : "String",
- "desc" : [
- "(center",
- "north",
- "south",
- "east",
- "west)"
- ],
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "any extra css",
+ "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"
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
}
],
"events" : [
{
- "name" : "activate",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "deactivate",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "render",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this tab is created",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "resize",
- "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"
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "addListener",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "addxtype",
+ "name" : "destroy",
"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" : ""
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "capture",
+ "name" : "disable",
"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"
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "destroy",
+ "name" : "enable",
"type" : "function",
- "desc" : "Destroys this panel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "fireEvent",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getChildContainer",
+ "name" : "layout",
"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"
+ "desc" : "Fires when a layout is performed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "getEl",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "getId",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "getLayout",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Returns the nested BorderLayout for this panel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "getTitle",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns this panel's title",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getToolbar",
+ "name" : "show",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ }
+ ],
+ "methods" : [
{
- "name" : "getUpdateManager",
+ "name" : "add",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : ""
},
{
- "name" : "hasListener",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "isClosable",
- "type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "load",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "on",
+ "name" : "addRegion",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Creates and adds a new region if it doesn't already exist.",
+ "sig" : "(target, config)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
},
{
- "name" : "purgeListeners",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "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" : "Roo.util.Observable"
+ "memberOf" : ""
},
{
- "name" : "refresh",
+ "name" : "beginUpdate",
"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" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "releaseCapture",
+ "name" : "capture",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "removeListener",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "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"
},
{
- "name" : "setContent",
+ "name" : "disable",
"type" : "function",
- "desc" : "Updates this panel's element",
- "sig" : "(content, loadScripts)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setTitle",
+ "name" : "enable",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setUrl",
+ "name" : "endUpdate",
"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" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "un",
+ "name" : "findPanel",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Searches all regions for a panel with the specified id",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.bootstrap.panel.TabItem" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when this tab becomes the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "beforeclose",
+ "name" : "fireEvent",
"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}",
- "memberOf" : ""
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "close",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires when this tab is closed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "deactivate",
- "type" : "function",
- "desc" : "Fires when this tab is no longer the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
- "memberOf" : ""
- }
- ],
- "methods" : [
- {
- "name" : "activate",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "addEvents",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns the Element this layout is bound to.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "addListener",
+ "name" : "getId",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "capture",
+ "name" : "getRegion",
"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"
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "disable",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
+ "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" : ""
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "enable",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Enables this TabPanelItem if it was previously disabled.",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "fireEvent",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "getText",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns the text for this tab",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "getUpdateManager",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
+ "desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
- },
- {
- "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"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "hide",
+ "name" : "isUpdating",
"type" : "function",
- "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
+ "desc" : "Returns true if this layout is currently being updated",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.layout.Manager"
},
{
- "name" : "isActive",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this tab is the active tab.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "isHidden",
+ "name" : "layout",
"type" : "function",
- "desc" : "Returns true if this tab is \"hidden\"",
+ "desc" : "Performs a layout update.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "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" : ""
- },
{
"name" : "releaseCapture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Remove a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "removeListener",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "setContent",
+ "name" : "render",
"type" : "function",
- "desc" : "Sets the content for this TabPanelItem.",
- "sig" : "(content, loadScripts)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setHidden",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Show or hide the tab",
- "sig" : "(hidden)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setText",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
- "sig" : "(text)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "setTooltip",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Set the tooltip for the tab.",
- "sig" : "(tooltip)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setUrl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
+ "sig" : "(panelId)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "show",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
+ "desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "un",
}
]
},
- "Roo.bootstrap.panel.Tabs" : {
+ "Roo.bootstrap.layout.Manager" : {
"props" : [
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
- {
- "name" : "beforetabchange",
- "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}",
- "memberOf" : ""
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "tabchange",
- "type" : "function",
- "desc" : "Fires when the active tab changes",
- "sig" : "function (_self, activePanel)\n{\n\n}",
- "memberOf" : ""
- }
- ],
- "methods" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : ""
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "addTab",
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "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"
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "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,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "layout",
+ "type" : "function",
+ "desc" : "Fires when a layout is performed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "addTabItem",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
- "sig" : "(item)",
- "static" : false,
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "autoSizeTabs",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "regionresized",
+ "type" : "function",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
"memberOf" : ""
},
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
{
"name" : "beginUpdate",
"type" : "function",
- "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this TabPanel",
- "sig" : "(removeEl)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "disableTab",
+ "name" : "disable",
"type" : "function",
- "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
- "sig" : "(id)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "enableTab",
+ "name" : "enable",
"type" : "function",
- "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
- "sig" : "(id)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "endUpdate",
"type" : "function",
- "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
"static" : false,
"memberOf" : ""
},
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "getActiveTab",
+ "name" : "focus",
"type" : "function",
- "desc" : "Gets the active {@link Roo.TabPanelItem}.",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "getCount",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the number of tabs in this TabPanel.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getRegion",
+ "type" : "function",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "getTab",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "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" : ""
},
+ {
+ "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"
+ },
{
"name" : "hasListener",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "hideTab",
+ "name" : "hide",
"type" : "function",
- "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "isUpdating",
+ "type" : "function",
+ "desc" : "Returns true if this layout is currently being updated",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
{
"name" : "on",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "removeTab",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes a {@link Roo.TabPanelItem}.",
- "sig" : "(id)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setTabWidth",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Resizes all the tabs to the passed width",
- "sig" : "(The)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "syncHeight",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
- "sig" : "(targetHeight)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "un",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "unhideTab",
+ "name" : "show",
"type" : "function",
- "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
- "sig" : "(id)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.data" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
- },
- "Roo.data.ArrayReader" : {
- "props" : [
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "Array of field definition objects",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "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" : ""
- }
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "newRow",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.DataReader"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "readRecords",
+ "name" : "un",
"type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(o)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
}
]
},
- "Roo.data.Connection" : {
+ "Roo.bootstrap.layout.Region" : {
"props" : [
{
- "name" : "autoAbort",
+ "name" : "alwaysShowTabs",
"type" : "Boolean",
- "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
"memberOf" : ""
},
{
- "name" : "defaultHeaders",
- "type" : "Object",
- "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "True to animate expand/collapse (defaults to false)",
"memberOf" : ""
},
{
- "name" : "disableCaching",
+ "name" : "autoHide",
"type" : "Boolean",
- "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
"memberOf" : ""
},
{
- "name" : "extraParams",
- "type" : "Object",
- "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
"memberOf" : ""
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "name" : "closeOnTab",
+ "type" : "Boolean",
+ "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "method",
- "type" : "String",
- "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
+ "name" : "cls",
+ "type" : "string",
+ "desc" : "Extra CSS classes to add to region",
"memberOf" : ""
},
{
- "name" : "timeout",
- "type" : "Number",
- "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "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" : "url",
- "type" : "String",
- "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
"memberOf" : ""
- }
- ],
- "events" : [
+ },
{
- "name" : "beforerequest",
- "type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (conn, options)\n{\n\n}",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
"memberOf" : ""
},
{
- "name" : "requestcomplete",
- "type" : "function",
- "desc" : "Fires if the request was successfully completed.",
- "sig" : "function (conn, response, options)\n{\n\n}",
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
"memberOf" : ""
},
{
- "name" : "requestexception",
- "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}",
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
"memberOf" : ""
- }
- ],
- "methods" : [
+ },
{
- "name" : "abort",
- "type" : "function",
- "desc" : "Aborts any outstanding request.",
- "sig" : "(transactionId)",
- "static" : false,
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
"memberOf" : ""
},
{
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : 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"
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : ""
},
{
- "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"
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : ""
},
{
- "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"
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : ""
},
{
- "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"
+ "name" : "overflow",
+ "type" : "String",
+ "desc" : "e) if you have menus in the region, then you need to set this to visible.",
+ "memberOf" : "",
+ "optvals" : [
+ "hidden",
+ "visible"
+ ]
},
{
- "name" : "isLoading",
- "type" : "function",
- "desc" : "Determine whether this object has a request outstanding.",
- "sig" : "(transactionId)",
- "static" : false,
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
"memberOf" : ""
},
{
- "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"
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "request",
- "type" : "function",
- "desc" : "Sends an HTTP request to a remote server.",
- "sig" : "(options)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.data.DataProxy" : {
- "props" : [
- ],
- "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}",
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
"memberOf" : ""
},
{
- "name" : "load",
- "type" : "function",
- "desc" : "Fires before the load method's callback is called.",
- "sig" : "function (This, o, arg)\n{\n\n}",
+ "name" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
"memberOf" : ""
},
{
- "name" : "loadexception",
- "type" : "function",
- "desc" : "Fires if an Exception occurs during data retrieval.",
- "sig" : "function (This, o, arg, e)\n{\n\n}",
- "memberOf" : ""
- }
- ],
- "methods" : [
- ]
- },
- "Roo.data.DataReader" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "newRow",
- "type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.data.HttpProxy" : {
- "props" : [
- {
- "name" : "autoAbort",
+ "name" : "resizeTabs",
"type" : "Boolean",
- "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
"memberOf" : ""
},
{
- "name" : "defaultHeaders",
- "type" : "Object",
- "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
- "memberOf" : ""
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "Roo.bootstrap.layout.Basic"
},
{
- "name" : "disableCaching",
+ "name" : "split",
"type" : "Boolean",
- "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "desc" : "To show the splitter",
"memberOf" : ""
},
{
- "name" : "extraParams",
- "type" : "Object",
- "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
- "memberOf" : ""
+ "name" : "tabPosition",
+ "type" : "String",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf" : "",
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
- "name" : "method",
+ "name" : "title",
"type" : "String",
- "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
+ "desc" : "The title for the region (overrides panel titles)",
"memberOf" : ""
},
{
- "name" : "timeout",
- "type" : "Number",
- "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
"memberOf" : ""
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
"memberOf" : ""
- }
- ],
- "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"
- },
- {
- "name" : "load",
- "type" : "function",
- "desc" : "Fires before the load method's callback is called.",
- "sig" : "function (This, o, arg)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy"
},
{
- "name" : "loadexception",
- "type" : "function",
- "desc" : "Fires if an Exception occurs during data retrieval.",
- "sig" : "function (This, o, arg, e)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy"
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : ""
}
],
+ "events" : [],
"methods" : [
{
- "name" : "getConnection",
+ "name" : "add",
"type" : "function",
- "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "load",
+ "name" : "addEvents",
"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.",
- "sig" : "(params, reader, callback, scope, arg)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.data.JsonReader" : {
- "props" : [
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "Array of field definition objects",
- "memberOf" : ""
- },
- {
- "name" : "id",
- "type" : "String",
- "desc" : "Name of the property within a row object that contains a record identifier value.",
- "memberOf" : ""
- },
- {
- "name" : "root",
- "type" : "String",
- "desc" : "name of the property which contains the Array of row objects.",
- "memberOf" : ""
- },
- {
- "name" : "successProperty",
- "type" : "String",
- "desc" : "Name of the property from which to retrieve the success attribute used by forms.",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "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" : ""
- }
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "newRow",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.data.DataReader"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "read",
+ "name" : "animateCollapse",
"type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "readRecords",
+ "name" : "animateExpand",
"type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(o)",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
"memberOf" : ""
- }
- ]
- },
- "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"
- },
- {
- "name" : "data",
- "type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
- "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"
},
{
- "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>",
+ "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"
},
{
- "name" : "multiSort",
- "type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "The Proxy object which provides access to a data object.",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "reader",
- "type" : "Roo.data.Reader",
- "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "remoteSort",
- "type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : "Roo.data.Store"
+ "name" : "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"
},
{
- "name" : "sortInfo",
- "type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store"
- }
- ],
- "events" : [
- {
- "name" : "add",
+ "name" : "getActivePanel",
"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" : "Get the active panel for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "beforeload",
+ "name" : "getBox",
"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" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "beforeloadadd",
+ "name" : "getEl",
"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" : "Returns the container element for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "clear",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store"
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Basic"
},
{
- "name" : "datachanged",
+ "name" : "getPosition",
"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"
+ "desc" : "Returns this regions position (north/south/east/west/center).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Basic"
},
{
- "name" : "load",
+ "name" : "getTabs",
"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"
+ "desc" : "Returns the TabPanel component used by this region",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "loadexception",
+ "name" : "hasListener",
"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" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "metachange",
+ "name" : "hasPanel",
"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" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Basic"
},
{
- "name" : "remove",
+ "name" : "hide",
"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"
+ "desc" : "Hides this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "update",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store"
- }
- ],
- "methods" : [
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
- "name" : "add",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
+ "desc" : "Returns true if this region is currently visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : ""
},
{
- "name" : "addEvents",
+ "name" : "on",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addListener",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "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"
},
{
- "name" : "clearFilter",
+ "name" : "remove",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
+ "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.data.Store"
+ "memberOf" : ""
},
{
- "name" : "collect",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "commitChanges",
+ "name" : "resizeTo",
"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" : "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.data.Store"
+ "memberOf" : "Roo.bootstrap.layout.Basic"
},
{
- "name" : "each",
+ "name" : "show",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "desc" : "Shows this region if it was previously hidden.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : ""
},
{
- "name" : "filter",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : ""
},
{
- "name" : "filterBy",
+ "name" : "un",
"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" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "fireEvent",
+ "name" : "unhidePanel",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.bootstrap.layout.Split" : {
+ "props" : [
+ {
+ "name" : "alwaysShowTabs",
+ "type" : "Boolean",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "getAt",
- "type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "True to animate expand/collapse (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "getById",
- "type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "autoHide",
+ "type" : "Boolean",
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "getCount",
- "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>",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "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"
+ "name" : "closeOnTab",
+ "type" : "Boolean",
+ "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "getRange",
- "type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "cmargins",
+ "type" : "Object",
+ "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "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"
+ "name" : "collapsed",
+ "type" : "Boolean",
+ "desc" : "True to set the initial display to collapsed (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "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"
+ "name" : "collapsedTitle",
+ "type" : "String",
+ "desc" : "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "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"
+ "name" : "collapsible",
+ "type" : "Boolean",
+ "desc" : "False to disable collapsing (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "indexOf",
- "type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "indexOfId",
- "type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "floatable",
+ "type" : "Boolean",
+ "desc" : "False to disable floating (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "insert",
- "type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "load",
- "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)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "loadData",
- "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)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "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"
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : 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"
},
{
- "name" : "query",
- "type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "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"
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "rejectChanges",
- "type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "reload",
- "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)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "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" : "remove",
- "type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "name" : "showPin",
+ "type" : "Boolean",
+ "desc" : "True to show a pin button",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "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"
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "tabPosition",
+ "type" : "String",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf" : "Roo.LayoutRegion",
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
- "name" : "setDefaultSort",
- "type" : "function",
- "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"
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "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"
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "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"
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "Roo.LayoutRegion"
}
- ]
- },
- "Roo.data.MemoryProxy" : {
- "props" : [
],
"events" : [
- ],
- "methods" : [
{
- "name" : "load",
+ "name" : "beforecollapse",
"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.",
- "sig" : "(params, reader, callback, scope, arg)",
- "static" : false,
- "memberOf" : ""
- }
- ]
- },
- "Roo.data.Node" : {
- "props" : [
+ "desc" : "Fires when this region before collapse.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
+ },
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id for this node. If one is not specified, one is generated.",
- "memberOf" : ""
+ "name" : "beforeremove",
+ "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"
},
{
- "name" : "leaf",
- "type" : "Boolean",
- "desc" : "true if this node is a leaf and does not have children",
- "memberOf" : ""
+ "name" : "collapsed",
+ "type" : "function",
+ "desc" : "Fires when this region is collapsed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
+ "name" : "expanded",
+ "type" : "function",
+ "desc" : "Fires when this region is expanded.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
+ },
{
- "name" : "append",
+ "name" : "invalidated",
"type" : "function",
- "desc" : "Fires when a new child node is appended",
- "sig" : "function (tree, _self, node, index)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when the layout for this region is changed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "beforeappend",
+ "name" : "panelactivated",
"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 when a panel is activated.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "beforeinsert",
+ "name" : "paneladded",
"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 when a panel is added.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "beforemove",
+ "name" : "panelremoved",
"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 a panel is removed.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "beforeremove",
+ "name" : "resized",
"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 when the user resizes this region.",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "insert",
+ "name" : "slidehide",
"type" : "function",
- "desc" : "Fires when a new child node is inserted.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when this region slides out of view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "move",
+ "name" : "slideshow",
"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 region is slid into view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "remove",
+ "name" : "visibilitychange",
"type" : "function",
- "desc" : "Fires when a child node is removed",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when this region is shown or hidden",
+ "sig" : "function (_self, visibility)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion"
}
],
"methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion"
+ },
{
"name" : "addEvents",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "appendChild",
- "type" : "function",
- "desc" : "Insert node(s) as the last child node of this node.",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "bubble",
- "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)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "capture",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "cascade",
+ "name" : "collapse",
"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" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "contains",
+ "name" : "expand",
"type" : "function",
- "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
- "sig" : "(node)",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "eachChild",
+ "name" : "fireEvent",
"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" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "findChild",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Finds the first child that has the attribute with the specified value.",
- "sig" : "(attribute, value)",
+ "desc" : "Get the active panel for this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "findChildBy",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
- "sig" : "(fn, scope)",
+ "desc" : "Returns the container element for this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "fireEvent",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "getDepth",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Returns depth of this node (the root node has a depth of 0)",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "getOwnerTree",
+ "name" : "getSplitBar",
"type" : "function",
- "desc" : "Returns the tree this node is in.",
+ "desc" : "Returns the {@link Roo.SplitBar} for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "getPath",
+ "name" : "getTabs",
"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 the TabPanel component used by this region",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "hasListener",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "indexOf",
- "type" : "function",
- "desc" : "Returns the index of a child node",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "insertBefore",
- "type" : "function",
- "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
- "sig" : "(node, refNode)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "isAncestor",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
- "sig" : "(node)",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "isFirst",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if this node is the first child of its parent",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "isLast",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Returns true if this node is the last child of its parent",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "isLeaf",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this node is a leaf",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
- },
- {
- "name" : "item",
- "type" : "function",
- "desc" : "Returns the child node at the specified index.",
- "sig" : "(index)",
- "static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "on",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "removeChild",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a child node from this node.",
- "sig" : "(node)",
+ "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" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "removeListener",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "replaceChild",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Replaces one child node in this node with another.",
- "sig" : "(newChild, oldChild)",
+ "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" : ""
+ "memberOf" : "Roo.BasicLayoutRegion"
},
{
- "name" : "sort",
+ "name" : "setCollapsedTitle",
"type" : "function",
- "desc" : "Sorts this nodes children using the supplied sort function",
- "sig" : "(fn, scope)",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- }
- ]
- },
- "Roo.data.Record" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "commit",
+ "name" : "show",
"type" : "function",
- "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
- },
- {
- "name" : "copy",
- "type" : "function",
- "desc" : "Creates a copy of this record.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "create",
- "type" : "function",
- "desc" : "Generate a constructor for a specific record layout.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "get",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Get the value of the named field.",
- "sig" : "(name)",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "reject",
+ "name" : "un",
"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}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "set",
+ "name" : "unhidePanel",
"type" : "function",
- "desc" : "Set the named field to the specified value.",
- "sig" : "(name, value)",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
}
]
},
- "Roo.data.ScriptTagProxy" : {
+ "Roo.bootstrap.menu" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.menu.Item" : {
"props" : [
{
- "name" : "callbackParam",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "(Optional) The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
- "memberOf" : ""
+ "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" : "nocache",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
- "memberOf" : ""
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "timeout",
- "type" : "Number",
- "desc" : "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
- "memberOf" : ""
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "url",
+ "name" : "cls",
"type" : "String",
- "desc" : "The URL from which to request the data object.",
- "memberOf" : ""
- }
- ],
- "events" : [
- ],
- "methods" : [
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
{
- "name" : "abort",
- "type" : "function",
- "desc" : "Abort the current server request.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "load",
- "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,
- "memberOf" : ""
- }
- ]
- },
- "Roo.data.SimpleStore" : {
- "props" : [
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
{
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store"
+ "name" : "disable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "data",
- "type" : "Array",
- "desc" : "The multi-dimensional array of data",
- "memberOf" : ""
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "fields",
- "type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "the link",
"memberOf" : ""
},
{
- "name" : "id",
- "type" : "Number",
- "desc" : "The array index of the record id. Leave blank to auto generate ids.",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "text of the item",
"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"
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "Font awesome icon",
+ "memberOf" : ""
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "multiSort",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "Submenu align to (left | right) default right",
+ "memberOf" : ""
+ },
+ {
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "Roo.data.Store"
+ "desc" : "e) default true",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "The Proxy object which provides access to a data object.",
- "memberOf" : "Roo.data.Store"
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "Roo.data.Store"
+ "name" : "submenu",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "reader",
- "type" : "Roo.data.Reader",
- "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf" : "Roo.data.Store"
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "remoteSort",
- "type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : "Roo.data.Store"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "sortInfo",
+ "name" : "xattr",
"type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store"
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
}
],
"events" : [
{
- "name" : "add",
+ "name" : "beforedestroy",
"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 before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "beforeload",
+ "name" : "beforehide",
"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 the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "beforeloadadd",
+ "name" : "beforerender",
"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 the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "clear",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "datachanged",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "load",
+ "name" : "click",
"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"
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "loadexception",
+ "name" : "destroy",
"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 after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "metachange",
+ "name" : "disable",
"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 after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "remove",
+ "name" : "enable",
"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"
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "update",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store"
- }
- ],
- "methods" : [
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
{
- "name" : "add",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "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"
- },
- {
- "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"
- },
- {
- "name" : "commitChanges",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "desc" : "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.data.Store"
- },
- {
- "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"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "filter",
+ "name" : "disable",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "filterBy",
+ "name" : "enable",
"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" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
"name" : "fireEvent",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "getAt",
- "type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "getById",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getCount",
+ "name" : "getChildContainer",
"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" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "getModifiedRecords",
+ "name" : "getEl",
"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 underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "getRange",
- "type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getSortState",
+ "name" : "getId",
"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" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getTotalCount",
+ "name" : "getVisibilityEl",
"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" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "hasListener",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "indexOf",
- "type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "indexOfId",
- "type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "insert",
+ "name" : "hide",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "load",
+ "name" : "initEvents",
"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" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "loadData",
+ "name" : "isVisible",
"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 component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "query",
- "type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
- "static" : false,
- "memberOf" : "Roo.data.Store"
- },
- {
- "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"
- },
- {
- "name" : "rejectChanges",
- "type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store"
- },
{
"name" : "releaseCapture",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "reload",
+ "name" : "removeListener",
"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" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "remove",
+ "name" : "render",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "removeAll",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "removeListener",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "setDefaultSort",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "sort",
+ "name" : "show",
"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" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "sum",
+ "name" : "tooltipEl",
"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" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "un",
}
]
},
- "Roo.data.SortTypes" : {
+ "Roo.bootstrap.menu.Menu" : {
"props" : [
- ],
- "events" : [
- ],
- "methods" : [
{
- "name" : "asDate",
- "type" : "function",
- "desc" : "Date sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : ""
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "asFloat",
- "type" : "function",
- "desc" : "Float sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : ""
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "asInt",
- "type" : "function",
- "desc" : "Integer sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : ""
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "asText",
- "type" : "function",
- "desc" : "Strips all HTML tags to sort on text only",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : ""
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "asUCString",
- "type" : "function",
- "desc" : "Case insensitive string",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : ""
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "asUCText",
- "type" : "function",
- "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : ""
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "none",
- "type" : "function",
- "desc" : "Default sort that does nothing",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : ""
- }
- ]
- },
- "Roo.data.Store" : {
- "props" : [
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
{
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "data",
- "type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "Text of the menu",
"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.",
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "Font awesome icon",
"memberOf" : ""
},
{
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "multiSort",
- "type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : ""
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "The Proxy object which provides access to a data object.",
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "Menu align to (top | bottom) default bottom",
"memberOf" : ""
},
{
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : ""
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "reader",
- "type" : "Roo.data.Reader",
- "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf" : ""
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "remoteSort",
- "type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : ""
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "sortInfo",
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e)",
+ "memberOf" : "",
+ "optvals" : [
+ "default",
+ "primary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "inverse"
+ ]
+ },
+ {
+ "name" : "xattr",
"type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : ""
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
}
],
"events" : [
{
- "name" : "add",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when Records have been added to the Store",
- "sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "beforeload",
+ "name" : "beforehide",
"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 this menu is hidden",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "beforeloadadd",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "clear",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
+ "desc" : "Fires before this menu is displayed",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "datachanged",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "load",
+ "name" : "click",
"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 this menu is clicked (or when the enter key is pressed while it is active)",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "loadexception",
+ "name" : "destroy",
"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" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "metachange",
+ "name" : "disable",
"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" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "remove",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when a Record has been removed from the Store",
- "sig" : "function (_self, record, index)\n{\n\n}",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after this menu is hidden",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "update",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after this menu is displayed",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "addEvents",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "clearFilter",
- "type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "collect",
- "type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "commitChanges",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "desc" : "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" : ""
- },
- {
- "name" : "each",
- "type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
- "static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "filter",
+ "name" : "disable",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "filterBy",
+ "name" : "enable",
"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" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "fireEvent",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "getAt",
- "type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "getById",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getCount",
+ "name" : "getChildContainer",
"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" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "getModifiedRecords",
+ "name" : "getEl",
"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 underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
- },
- {
- "name" : "getRange",
- "type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
- "static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getSortState",
+ "name" : "getId",
"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" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getTotalCount",
+ "name" : "getVisibilityEl",
"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" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "hasListener",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "indexOf",
- "type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "indexOfId",
- "type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "insert",
+ "name" : "hide",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "load",
+ "name" : "initEvents",
"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" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "loadData",
+ "name" : "isVisible",
"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 component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "query",
- "type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "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" : ""
- },
- {
- "name" : "rejectChanges",
- "type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "releaseCapture",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "reload",
+ "name" : "removeListener",
"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" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "remove",
+ "name" : "render",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "removeAll",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "removeListener",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "setDefaultSort",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "sort",
+ "name" : "show",
"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" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "sum",
+ "name" : "tooltipEl",
"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" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "un",
}
]
},
- "Roo.data.Tree" : {
+ "Roo.bootstrap.menu.Separator" : {
"props" : [
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
- {
- "name" : "append",
- "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" : ""
+ "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" : "beforeappend",
- "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" : ""
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "beforeinsert",
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "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"
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component",
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before 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" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "beforemove",
+ "name" : "beforehide",
"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" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "beforeremove",
+ "name" : "beforerender",
"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" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "insert",
+ "name" : "beforeshow",
"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" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "move",
+ "name" : "childrenrendered",
"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" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "remove",
+ "name" : "destroy",
"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" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
}
],
"methods" : [
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "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"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
{
"name" : "fireEvent",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "getNodeById",
+ "name" : "focus",
"type" : "function",
- "desc" : "Gets a node in this tree by its id.",
- "sig" : "(id)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getRootNode",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the root node for this tree.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
},
{
"name" : "hasListener",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
{
"name" : "on",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "setRootNode",
+ "name" : "render",
"type" : "function",
- "desc" : "Sets the root node for this tree.",
- "sig" : "(node)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "un",
}
]
},
- "Roo.data.XmlReader" : {
+ "Roo.bootstrap.panel" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.bootstrap.panel.Content" : {
"props" : [
{
- "name" : "id",
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : ""
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : ""
+ },
+ {
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : ""
+ },
+ {
+ "name" : "background",
+ "type" : "Boolean",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "badges",
+ "type" : "Boolean",
+ "desc" : "render the badges",
+ "memberOf" : ""
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : ""
+ },
+ {
+ "name" : "content",
"type" : "String",
- "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
"memberOf" : ""
},
{
- "name" : "record",
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : ""
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : ""
+ },
+ {
+ "name" : "region",
"type" : "String",
- "desc" : "The DomQuery path to the repeated element which contains record information.",
+ "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "",
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
+ },
+ {
+ "name" : "resizeEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
"memberOf" : ""
},
{
- "name" : "success",
+ "name" : "title",
"type" : "String",
- "desc" : "The DomQuery path to the success attribute used by forms.",
+ "desc" : "The title for this panel",
"memberOf" : ""
},
{
- "name" : "totalRecords",
+ "name" : "toolbar",
+ "type" : "Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : ""
+ },
+ {
+ "name" : "url",
"type" : "String",
- "desc" : "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
+ "desc" : "Calls {@link #setUrl} with this value",
"memberOf" : ""
}
],
"events" : [
- ],
- "methods" : [
{
- "name" : "newRow",
+ "name" : "activate",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "Roo.data.DataReader"
+ "desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "read",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
- "static" : false,
+ "desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "readRecords",
+ "name" : "render",
"type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(doc)",
- "static" : false,
+ "desc" : "Fires when this tab is created",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
- }
- ]
- },
- "Roo.dd" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
- },
- "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"
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : ""
}
],
- "events" : [
- ],
"methods" : [
{
"name" : "addEvents",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleId",
+ "name" : "capture",
"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"
+ "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"
},
{
- "name" : "addInvalidHandleType",
+ "name" : "destroy",
"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" : "Destroys this panel",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "addListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addToGroup",
+ "name" : "getChildContainer",
"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" : "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "alignElWithMouse",
+ "name" : "getEl",
"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" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "applyConfig",
+ "name" : "getId",
"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 this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "autoOffset",
+ "name" : "getTitle",
"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)",
+ "desc" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "cachePosition",
+ "name" : "getToolbar",
"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" : "Returns the toolbar for this Panel if one was configured.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "capture",
+ "name" : "getUpdateManager",
"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"
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
},
{
- "name" : "clearConstraints",
+ "name" : "hasListener",
"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" : "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"
},
{
- "name" : "clearTicks",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "endDrag",
+ "name" : "load",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "fireEvent",
+ "name" : "on",
"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 element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "getDragEl",
+ "name" : "purgeListeners",
"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" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "getEl",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "hasListener",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "init",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "initTarget",
+ "name" : "setContent",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Updates this panel's element",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "isLocked",
+ "name" : "setTitle",
"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}",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "isTarget",
+ "name" : "setUrl",
"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}",
+ "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "isValidHandleChild",
+ "name" : "un",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.bootstrap.panel.Grid" : {
+ "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"
},
{
- "name" : "lock",
- "type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "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"
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onAvailable",
- "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"
+ "name" : "background",
+ "type" : "Boolean",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onDrag",
- "type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "badges",
+ "type" : "Boolean",
+ "desc" : "render the badges",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onDragDrop",
- "type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onDragEnter",
- "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"
+ "name" : "content",
+ "type" : "String",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onDragOut",
- "type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onDragOver",
- "type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onInvalidDrop",
- "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"
+ "name" : "grid",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "The grid for this panel",
+ "memberOf" : ""
},
{
- "name" : "onMouseDown",
- "type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "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" : "onMouseUp",
- "type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "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" : "Roo.dd.DragDrop"
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "region",
+ "type" : "String",
+ "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "name" : "resizeEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "removeFromGroup",
- "type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "removeInvalidHandleClass",
- "type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "toolbar",
+ "type" : "Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "removeListener",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires when this tab is created",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "resetConstraints",
+ "name" : "resize",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "setDelta",
+ "name" : "addListener",
"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)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "setDragElId",
+ "name" : "capture",
"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" : "Roo.dd.DragDrop"
+ "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"
},
{
- "name" : "setDragElPos",
+ "name" : "destroy",
"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)",
+ "desc" : "Destroys this panel",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "setHandleElId",
+ "name" : "fireEvent",
"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" : "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"
},
{
- "name" : "setInitPosition",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "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.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "setOuterHandleElId",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "setPadding",
+ "name" : "getGrid",
"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" : "Returns the grid for this panel",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setXConstraint",
+ "name" : "getId",
"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" : "Returns this panel's id",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "setYConstraint",
+ "name" : "getTitle",
"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" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "startDrag",
+ "name" : "getToolbar",
"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" : "Returns the toolbar for this Panel if one was configured.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "toString",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "toString method",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "un",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "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"
},
{
- "name" : "unlock",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Unlock this instace",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "unreg",
+ "name" : "load",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "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}.",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- }
- ]
- },
- "Roo.dd.DDProxy" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
- ],
- "methods" : [
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
{
- "name" : "addEvents",
+ "name" : "on",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleId",
+ "name" : "refresh",
"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" : "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.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "addInvalidHandleType",
+ "name" : "releaseCapture",
"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"
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "addListener",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addToGroup",
+ "name" : "setContent",
"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" : "Updates this panel's element",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "alignElWithMouse",
+ "name" : "setTitle",
"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" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.dd.DD"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "applyConfig",
+ "name" : "setUrl",
"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" : "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.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "autoOffset",
+ "name" : "un",
"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)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DD"
- },
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.bootstrap.panel.Nest" : {
+ "props" : [
{
- "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"
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "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,
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "background",
+ "type" : "Boolean",
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "badges",
+ "type" : "Boolean",
+ "desc" : "render the badges",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "content",
+ "type" : "String",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "fitContainer",
+ "type" : "Boolean",
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "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" : "clearConstraints",
- "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" : "Roo.dd.DragDrop"
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "clearTicks",
- "type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "createFrame",
- "type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "name" : "region",
+ "type" : "String",
+ "desc" : "t) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
},
{
- "name" : "endDrag",
- "type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "resizeEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "fireEvent",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "toolbar",
+ "type" : "Toolbar",
+ "desc" : "A toolbar for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "getDragEl",
+ "name" : "deactivate",
"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" : "Roo.dd.DragDrop"
+ "desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "getEl",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires when this tab is created",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "hasListener",
+ "name" : "resize",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "init",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "initFrame",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
- "sig" : "()\n{\n\n}",
+ "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" : ""
},
{
- "name" : "initTarget",
+ "name" : "capture",
"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"
+ "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"
},
{
- "name" : "isLocked",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "isTarget",
+ "name" : "fireEvent",
"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}",
+ "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"
},
{
- "name" : "isValidHandleChild",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "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.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "lock",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Lock this instance",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- },
- {
- "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"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onAvailable",
+ "name" : "getId",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onDrag",
+ "name" : "getLayout",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Returns the nested BorderLayout for this panel",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onDragDrop",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onDragEnter",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onDragOut",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onDragOver",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, 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"
},
{
- "name" : "onInvalidDrop",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "desc" : "Returns true is this panel was configured to be closable",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onMouseDown",
+ "name" : "load",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "onMouseUp",
+ "name" : "on",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "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"
},
{
- "name" : "padding",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "purgeListeners",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "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.util.Observable"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
"name" : "releaseCapture",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "removeFromGroup",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "setContent",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Updates this panel's element",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "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.dd.DragDrop"
+ "memberOf" : "Roo.bootstrap.panel.Content"
},
{
- "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"
+ }
+ ]
+ },
+ "Roo.bootstrap.panel.TabItem" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "activate",
+ "type" : "function",
+ "desc" : "Fires when this tab becomes the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "resetConstraints",
+ "name" : "beforeclose",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "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" : ""
+ },
+ {
+ "name" : "close",
+ "type" : "function",
+ "desc" : "Fires when this tab is closed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "deactivate",
+ "type" : "function",
+ "desc" : "Fires when this tab is no longer the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "memberOf" : ""
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "activate",
+ "type" : "function",
+ "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setDelta",
+ "name" : "addEvents",
"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)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DD"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "setDragElId",
+ "name" : "addListener",
"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" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "setDragElPos",
+ "name" : "capture",
"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)",
+ "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"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD"
+ "memberOf" : ""
},
{
- "name" : "setHandleElId",
+ "name" : "enable",
"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" : "Enables this TabPanelItem if it was previously disabled.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setInitPosition",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "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"
},
{
- "name" : "setOuterHandleElId",
+ "name" : "getText",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Returns the text for this tab",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setPadding",
+ "name" : "getUpdateManager",
"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" : "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setXConstraint",
+ "name" : "hasListener",
"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" : "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"
},
{
- "name" : "setYConstraint",
+ "name" : "hide",
"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" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "startDrag",
+ "name" : "isActive",
"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" : "Returns true if this tab is the active tab.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "toString",
+ "name" : "isHidden",
"type" : "function",
- "desc" : "toString method",
+ "desc" : "Returns true if this tab is \"hidden\"",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "un",
+ "name" : "on",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "unlock",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Unlock this instace",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "unreg",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
+ "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.dd.DragDrop"
- }
- ]
- },
- "Roo.dd.DDTarget" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
- ],
- "methods" : [
+ "memberOf" : ""
+ },
{
- "name" : "addEvents",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleId",
+ "name" : "setContent",
"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" : "Sets the content for this TabPanelItem.",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "addInvalidHandleType",
+ "name" : "setHidden",
"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" : "Show or hide the tab",
+ "sig" : "(hidden)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "addListener",
+ "name" : "setText",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
},
{
- "name" : "addToGroup",
+ "name" : "setTooltip",
"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" : "Set the tooltip for the tab.",
+ "sig" : "(tooltip)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "applyConfig",
+ "name" : "setUrl",
"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" : "Set a URL to be used to load the content for this TabPanelItem.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- },
- {
- "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"
+ "memberOf" : ""
},
{
- "name" : "clearConstraints",
+ "name" : "show",
"type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "clearTicks",
+ "name" : "un",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- },
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.bootstrap.panel.Tabs" : {
+ "props" : [
{
- "name" : "endDrag",
- "type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- },
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ }
+ ],
+ "events" : [
{
- "name" : "fireEvent",
+ "name" : "beforetabchange",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "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" : ""
},
{
- "name" : "getDragEl",
+ "name" : "tabchange",
"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" : "Roo.dd.DragDrop"
- },
+ "desc" : "Fires when the active tab changes",
+ "sig" : "function (_self, activePanel)\n{\n\n}",
+ "memberOf" : ""
+ }
+ ],
+ "methods" : [
{
- "name" : "getEl",
+ "name" : "activate",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "hasListener",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "init",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "initTarget",
+ "name" : "addTab",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "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" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "isLocked",
+ "name" : "addTabItem",
"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}",
+ "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
+ "sig" : "(item)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "isTarget",
+ "name" : "autoSizeTabs",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "isValidHandleChild",
+ "name" : "beginUpdate",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "lock",
+ "name" : "capture",
"type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "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"
},
{
- "name" : "on",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Destroys this TabPanel",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
},
{
- "name" : "onAvailable",
+ "name" : "disableTab",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onDrag",
+ "name" : "enableTab",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onDragDrop",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onDragEnter",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
+ "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"
},
{
- "name" : "onDragOut",
+ "name" : "getActiveTab",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "Gets the active {@link Roo.TabPanelItem}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onDragOver",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Returns the number of tabs in this TabPanel.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onInvalidDrop",
+ "name" : "getTab",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onMouseDown",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "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"
},
{
- "name" : "onMouseUp",
+ "name" : "hideTab",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "padding",
+ "name" : "on",
"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}",
+ "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"
},
{
"name" : "purgeListeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "removeFromGroup",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "removeTab",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Removes a {@link Roo.TabPanelItem}.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "setTabWidth",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "Resizes all the tabs to the passed width",
+ "sig" : "(The)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "syncHeight",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
+ "sig" : "(targetHeight)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "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"
},
{
- "name" : "resetConstraints",
- "type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- },
- {
- "name" : "setDragElId",
+ "name" : "unhideTab",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.data" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.data.ArrayReader" : {
+ "props" : [
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "Array of field definition objects",
+ "memberOf" : ""
},
{
- "name" : "setHandleElId",
+ "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" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
"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" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.data.DataReader"
},
{
- "name" : "setInitPosition",
+ "name" : "readRecords",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(o)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.data.Connection" : {
+ "props" : [
+ {
+ "name" : "autoAbort",
+ "type" : "Boolean",
+ "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "setOuterHandleElId",
- "type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "defaultHeaders",
+ "type" : "Object",
+ "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "memberOf" : ""
},
{
- "name" : "setPadding",
- "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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "disableCaching",
+ "type" : "Boolean",
+ "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf" : ""
},
{
- "name" : "setXConstraint",
- "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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "extraParams",
+ "type" : "Object",
+ "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf" : ""
},
{
- "name" : "setYConstraint",
- "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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "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" : "startDrag",
- "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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "method",
+ "type" : "String",
+ "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
+ "memberOf" : ""
},
{
- "name" : "toString",
- "type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : ""
},
{
- "name" : "un",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforerequest",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (conn, options)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "unlock",
+ "name" : "requestcomplete",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires if the request was successfully completed.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "unreg",
+ "name" : "requestexception",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- }
- ]
- },
- "Roo.dd.DragDrop" : {
- "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"
+ "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" : ""
}
],
- "events" : [
- ],
"methods" : [
+ {
+ "name" : "abort",
+ "type" : "function",
+ "desc" : "Aborts any outstanding request.",
+ "sig" : "(transactionId)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "addEvents",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleId",
+ "name" : "capture",
"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" : ""
+ "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"
},
{
- "name" : "addInvalidHandleType",
+ "name" : "fireEvent",
"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" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "addListener",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addToGroup",
+ "name" : "isLoading",
"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" : "Determine whether this object has a request outstanding.",
+ "sig" : "(transactionId)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "applyConfig",
+ "name" : "on",
"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" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "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"
},
{
- "name" : "clearConstraints",
+ "name" : "releaseCapture",
"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" : ""
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "clearTicks",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "endDrag",
+ "name" : "request",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Sends an HTTP request to a remote server.",
+ "sig" : "(options)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "fireEvent",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
+ }
+ ]
+ },
+ "Roo.data.DataProxy" : {
+ "props" : [],
+ "events" : [
{
- "name" : "getDragEl",
+ "name" : "beforeload",
"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,
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "getEl",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "hasListener",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : ""
+ }
+ ],
+ "methods" : []
+ },
+ "Roo.data.DataReader" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "init",
+ "name" : "newRow",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
"memberOf" : ""
+ }
+ ]
+ },
+ "Roo.data.HttpProxy" : {
+ "props" : [
+ {
+ "name" : "autoAbort",
+ "type" : "Boolean",
+ "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "initTarget",
- "type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
- "static" : false,
+ "name" : "defaultHeaders",
+ "type" : "Object",
+ "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
"memberOf" : ""
},
{
- "name" : "isLocked",
- "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,
+ "name" : "disableCaching",
+ "type" : "Boolean",
+ "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
"memberOf" : ""
},
{
- "name" : "isTarget",
- "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,
+ "name" : "extraParams",
+ "type" : "Object",
+ "desc" : "(Optional) An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
"memberOf" : ""
},
{
- "name" : "isValidHandleChild",
- "type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
- "static" : false,
+ "name" : "method",
+ "type" : "String",
+ "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
"memberOf" : ""
},
{
- "name" : "lock",
- "type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
"memberOf" : ""
},
{
- "name" : "on",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy"
},
{
- "name" : "onAvailable",
+ "name" : "load",
"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" : ""
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy"
},
{
- "name" : "onDrag",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "getConnection",
+ "type" : "function",
+ "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "onDragDrop",
+ "name" : "load",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, 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" : ""
+ }
+ ]
+ },
+ "Roo.data.JsonReader" : {
+ "props" : [
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "Array of field definition objects",
+ "memberOf" : ""
},
{
- "name" : "onDragEnter",
- "type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
+ "name" : "id",
+ "type" : "String",
+ "desc" : "Name of the property within a row object that contains a record identifier value.",
"memberOf" : ""
},
{
- "name" : "onDragOut",
- "type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
- "static" : false,
+ "name" : "root",
+ "type" : "String",
+ "desc" : "name of the property which contains the Array of row objects.",
"memberOf" : ""
},
{
- "name" : "onDragOver",
- "type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
+ "name" : "successProperty",
+ "type" : "String",
+ "desc" : "Name of the property from which to retrieve the success attribute used by forms.",
"memberOf" : ""
},
{
- "name" : "onInvalidDrop",
+ "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" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.DataReader"
},
{
- "name" : "onMouseDown",
+ "name" : "read",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
+ "sig" : "(response)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "onMouseUp",
+ "name" : "readRecords",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(o)",
"static" : false,
"memberOf" : ""
+ }
+ ]
+ },
+ "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"
},
{
- "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,
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "Inline data to be loaded when the store is initialized.",
+ "memberOf" : "Roo.data.Store"
+ },
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "An array of field definition objects, or field name strings.",
"memberOf" : ""
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "isLocal",
+ "type" : "boolean",
+ "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf" : "Roo.data.Store"
+ },
+ {
+ "name" : "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" : "releaseCapture",
+ "name" : "multiSort",
+ "type" : "Boolean",
+ "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf" : "Roo.data.Store"
+ },
+ {
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "The Proxy object which provides access to a data object.",
+ "memberOf" : "Roo.data.Store"
+ },
+ {
+ "name" : "pruneModifiedRecords",
+ "type" : "boolean",
+ "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf" : "Roo.data.Store"
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.Reader",
+ "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "memberOf" : "Roo.data.Store"
+ },
+ {
+ "name" : "remoteSort",
+ "type" : "boolean",
+ "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf" : "Roo.data.Store"
+ },
+ {
+ "name" : "sortInfo",
+ "type" : "Object",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : "Roo.data.Store"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "add",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "removeFromGroup",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
- "static" : false,
- "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"
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : ""
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "clear",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : ""
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "datachanged",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : ""
+ "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"
},
{
- "name" : "removeListener",
+ "name" : "load",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "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"
},
{
- "name" : "resetConstraints",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
- "static" : false,
- "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 (, return, load, jsonData)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "setDragElId",
+ "name" : "metachange",
"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" : ""
+ "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"
},
{
- "name" : "setHandleElId",
+ "name" : "remove",
"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" : ""
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "setInitPosition",
+ "name" : "update",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "setOuterHandleElId",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "setPadding",
+ "name" : "addListener",
"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 component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "setXConstraint",
+ "name" : "capture",
"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)",
- "static" : false,
- "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"
},
{
- "name" : "setYConstraint",
+ "name" : "clearFilter",
"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" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "startDrag",
+ "name" : "collect",
"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" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "toString",
+ "name" : "commitChanges",
"type" : "function",
- "desc" : "toString method",
+ "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" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "un",
+ "name" : "each",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "unlock",
+ "name" : "filter",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "unreg",
+ "name" : "filterBy",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
+ "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.dd.DragDropMgr" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
+ "memberOf" : "Roo.data.Store"
+ },
{
- "name" : "getBestMatch",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode. It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element.",
- "sig" : "(dds)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "getCss",
+ "name" : "getAt",
"type" : "function",
- "desc" : "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)",
- "sig" : "(id)",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "getDDById",
+ "name" : "getById",
"type" : "function",
- "desc" : "Returns the DragDrop instance for a given id",
+ "desc" : "Get the Record with the specified id.",
"sig" : "(id)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "getElement",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Returns the actual DOM element",
- "sig" : "(id)",
+ "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"
},
{
- "name" : "getLocation",
+ "name" : "getModifiedRecords",
"type" : "function",
- "desc" : "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it",
- "sig" : "(oDD)",
+ "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"
},
{
- "name" : "getPosX",
+ "name" : "getRange",
"type" : "function",
- "desc" : "Returns the X position of an html element",
- "sig" : "(el)",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "getPosY",
+ "name" : "getSortState",
"type" : "function",
- "desc" : "Returns the Y position of an html element",
- "sig" : "(el)",
+ "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" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "getRelated",
+ "name" : "getTotalCount",
"type" : "function",
- "desc" : "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to.",
- "sig" : "(p_oDD, bTargetsOnly)",
+ "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" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "getScrollLeft",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Gets the scrollLeft",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "getScrollTop",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Gets the scrollTop",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "getStyle",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Returns the specified element style property",
- "sig" : "(el, styleProp)",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "handleWasClicked",
+ "name" : "insert",
"type" : "function",
- "desc" : "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked.",
- "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"
},
{
- "name" : "isDragDrop",
+ "name" : "load",
"type" : "function",
- "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop item.",
- "sig" : "(id)",
+ "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"
},
{
- "name" : "isHandle",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object.",
- "sig" : "(id)",
+ "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"
},
{
- "name" : "isLegalTarget",
+ "name" : "loadDataFromChildren",
"type" : "function",
- "desc" : "Returns true if the specified dd target is a legal target for\nthe specifice drag obj",
- "sig" : "(the, the)",
+ "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"
},
{
- "name" : "isLocked",
+ "name" : "on",
"type" : "function",
- "desc" : "Is drag and drop locked?",
- "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"
},
{
- "name" : "isTypeOfDD",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop.",
- "sig" : "(the)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "lock",
+ "name" : "query",
"type" : "function",
- "desc" : "Lock all drag and drop functionality",
- "sig" : "()\n{\n\n}",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "moveToEl",
+ "name" : "queryBy",
"type" : "function",
- "desc" : "Sets the x/y position of an element to the location of the\ntarget element.",
- "sig" : "(moveEl, targetEl)",
+ "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" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "numericSort",
+ "name" : "rejectChanges",
"type" : "function",
- "desc" : "Numeric array sort function",
+ "desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "refreshCache",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n<code>\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n</code>\nAlternatively:\n<code>\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n</code>",
- "sig" : "(groups)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "reload",
+ "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)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "regDragDrop",
+ "name" : "remove",
"type" : "function",
- "desc" : "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()",
- "sig" : "(oDD, sGroup)",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "regHandle",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()",
- "sig" : "(sDDId, sHandleId)",
+ "desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "startDrag",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met.",
- "sig" : "(x, y)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "stopEvent",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Utility to stop event propagation and event default, if these\nfeatures are turned on.",
- "sig" : "(e)",
+ "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"
},
{
- "name" : "swapNode",
+ "name" : "sort",
"type" : "function",
- "desc" : "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior",
- "sig" : "(n1, n2)",
+ "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"
},
{
- "name" : "unlock",
+ "name" : "sum",
"type" : "function",
- "desc" : "Unlock all drag and drop functionality",
- "sig" : "()\n{\n\n}",
+ "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"
},
{
- "name" : "verifyEl",
+ "name" : "un",
"type" : "function",
- "desc" : "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element",
- "sig" : "(el)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.data.MemoryProxy" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "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.",
+ "sig" : "(params, reader, callback, scope, arg)",
"static" : false,
"memberOf" : ""
}
]
},
- "Roo.dd.DragSource" : {
+ "Roo.data.Node" : {
"props" : [
{
- "name" : "dropAllowed",
+ "name" : "id",
"type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "desc" : "The id for this node. If one is not specified, one is generated.",
"memberOf" : ""
},
{
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "name" : "leaf",
+ "type" : "Boolean",
+ "desc" : "true if this node is a leaf and does not have children",
"memberOf" : ""
},
{
}
],
"events" : [
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "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"
- },
- {
- "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"
- },
{
- "name" : "addInvalidHandleType",
+ "name" : "append",
"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"
+ "desc" : "Fires when a new child node is appended",
+ "sig" : "function (tree, _self, node, index)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "addListener",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires before a new child is appended, return false to cancel the append.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "addToGroup",
+ "name" : "beforeinsert",
"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"
+ "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "alignElWithMouse",
+ "name" : "beforemove",
"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"
+ "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" : ""
},
{
- "name" : "applyConfig",
+ "name" : "beforeremove",
"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" : "Roo.dd.DragDrop"
+ "desc" : "Fires before a child is removed, return false to cancel the remove.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "autoOffset",
+ "name" : "insert",
"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"
+ "desc" : "Fires when a new child node is inserted.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "beforeDragDrop",
+ "name" : "move",
"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,
+ "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" : ""
},
{
- "name" : "beforeDragEnter",
+ "name" : "remove",
"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,
+ "desc" : "Fires when a child node is removed",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
"memberOf" : ""
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "beforeDragOut",
+ "name" : "addEvents",
"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)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "beforeDragOver",
+ "name" : "addListener",
"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)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "beforeInvalidDrop",
+ "name" : "appendChild",
"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" : "Insert node(s) as the last child node of this node.",
+ "sig" : "(node)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "cachePosition",
+ "name" : "bubble",
"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" : "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.dd.DD"
+ "memberOf" : ""
},
{
"name" : "capture",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "clearConstraints",
+ "name" : "cascade",
"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" : "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "clearTicks",
+ "name" : "contains",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "createFrame",
+ "name" : "eachChild",
"type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
+ "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.dd.DDProxy"
+ "memberOf" : ""
},
{
- "name" : "endDrag",
+ "name" : "findChild",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Finds the first child that has the attribute with the specified value.",
+ "sig" : "(attribute, value)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
+ },
+ {
+ "name" : "findChildBy",
+ "type" : "function",
+ "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : ""
},
{
"name" : "fireEvent",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "getDragData",
+ "name" : "getDepth",
"type" : "function",
- "desc" : "Returns the data object associated with this drag source",
+ "desc" : "Returns depth of this node (the root node has a depth of 0)",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "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" : "Roo.dd.DragDrop"
- },
- {
- "name" : "getEl",
+ "name" : "getOwnerTree",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "desc" : "Returns the tree this node is in.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "getProxy",
+ "name" : "getPath",
"type" : "function",
- "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
+ "sig" : "(attr)",
"static" : false,
"memberOf" : ""
},
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "hideProxy",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the index of a child node",
+ "sig" : "(node)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "init",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
+ "sig" : "(node, refNode)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "initFrame",
+ "name" : "isAncestor",
"type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DDProxy"
+ "memberOf" : ""
},
{
- "name" : "initTarget",
+ "name" : "isFirst",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Returns true if this node is the first child of its parent",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "isLocked",
+ "name" : "isLast",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "desc" : "Returns true if this node is the last child of its parent",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "isTarget",
+ "name" : "isLeaf",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "desc" : "Returns true if this node is a leaf",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "isValidHandleChild",
+ "name" : "item",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Returns the child node at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "lock",
+ "name" : "on",
"type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- },
- {
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "onAvailable",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "onBeforeDrag",
+ "name" : "releaseCapture",
"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" : ""
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "onDrag",
+ "name" : "removeChild",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Removes a child node from this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onDragDrop",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "onDragEnter",
+ "name" : "replaceChild",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Replaces one child node in this node with another.",
+ "sig" : "(newChild, oldChild)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onDragOut",
+ "name" : "sort",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "Sorts this nodes children using the supplied sort function",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onDragOver",
+ "name" : "un",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- },
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.data.Record" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "onInvalidDrop",
+ "name" : "commit",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "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" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onMouseDown",
+ "name" : "copy",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Creates a copy of this record.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "onMouseUp",
+ "name" : "create",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Generate a constructor for a specific record layout.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : ""
},
{
- "name" : "onStartDrag",
+ "name" : "get",
"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)",
+ "desc" : "Get the value of the named field.",
+ "sig" : "(name)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "padding",
+ "name" : "reject",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "purgeListeners",
+ "name" : "set",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Set the named field to the specified value.",
+ "sig" : "(name, value)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.data.ScriptTagProxy" : {
+ "props" : [
+ {
+ "name" : "callbackParam",
+ "type" : "String",
+ "desc" : "(Optional) The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
+ "memberOf" : ""
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "name" : "nocache",
+ "type" : "Boolean",
+ "desc" : "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
+ "memberOf" : ""
},
{
- "name" : "removeFromGroup",
- "type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
+ "memberOf" : ""
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The URL from which to request the data object.",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "abort",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "Abort the current server request.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "load",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "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" : "Roo.dd.DragDrop"
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.data.SimpleStore" : {
+ "props" : [
+ {
+ "name" : "an",
+ "type" : "Object",
+ "desc" : "existing reader (eg. copied from another store)",
+ "memberOf" : ""
},
{
- "name" : "removeInvalidHandleType",
- "type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "The multi-dimensional array of data",
+ "memberOf" : ""
},
{
- "name" : "resetConstraints",
- "type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "An array of field definition objects, or field name strings.",
+ "memberOf" : ""
},
{
- "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"
+ "name" : "id",
+ "type" : "Number",
+ "desc" : "The array index of the record id. Leave blank to auto generate ids.",
+ "memberOf" : ""
},
{
- "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" : "Roo.dd.DragDrop"
+ "name" : "isLocal",
+ "type" : "boolean",
+ "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "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"
+ "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" : "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" : "Roo.dd.DragDrop"
+ "name" : "multiSort",
+ "type" : "Boolean",
+ "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "setInitPosition",
- "type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "The Proxy object which provides access to a data object.",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "setOuterHandleElId",
- "type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "pruneModifiedRecords",
+ "type" : "boolean",
+ "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "setPadding",
- "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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "reader",
+ "type" : "Roo.data.Reader",
+ "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "setXConstraint",
- "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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "name" : "remoteSort",
+ "type" : "boolean",
+ "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "setYConstraint",
+ "name" : "sortInfo",
+ "type" : "Object",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : "Roo.data.Store"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "add",
"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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "startDrag",
+ "name" : "beforeload",
"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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "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"
},
{
- "name" : "toString",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "un",
+ "name" : "clear",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "unlock",
+ "name" : "datachanged",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "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"
},
{
- "name" : "unreg",
+ "name" : "load",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- }
- ]
- },
- "Roo.dd.DragZone" : {
- "props" : [
- {
- "name" : "containerScroll",
- "type" : "Boolean",
- "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
- "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"
},
{
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "Roo.dd.DragSource"
+ "name" : "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"
},
{
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "Roo.dd.DragSource"
+ "name" : "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"
},
{
- "name" : "hlColor",
- "type" : "String",
- "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)",
- "memberOf" : ""
+ "name" : "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"
},
{
- "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" : "update",
+ "type" : "function",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "Roo.data.Store"
}
],
- "events" : [
- ],
"methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store"
+ },
{
"name" : "addEvents",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "addInvalidHandleId",
+ "name" : "capture",
"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"
+ "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"
},
{
- "name" : "addInvalidHandleType",
+ "name" : "clearFilter",
"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" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "addListener",
+ "name" : "collect",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "addToGroup",
+ "name" : "commitChanges",
"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" : "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.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "afterRepair",
+ "name" : "each",
"type" : "function",
- "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel",
- "sig" : "()\n{\n\n}",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "alignElWithMouse",
+ "name" : "filter",
"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" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "Roo.dd.DD"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "applyConfig",
+ "name" : "filterBy",
"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" : "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.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "autoOffset",
+ "name" : "fireEvent",
"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)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.dd.DD"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "beforeDragDrop",
+ "name" : "getAt",
"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" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "beforeDragEnter",
+ "name" : "getById",
"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" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "beforeDragOut",
+ "name" : "getCount",
"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)",
+ "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.dd.DragSource"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "beforeDragOver",
+ "name" : "getModifiedRecords",
"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)",
+ "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.dd.DragSource"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "beforeInvalidDrop",
+ "name" : "getRange",
"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" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "cachePosition",
+ "name" : "getSortState",
"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" : "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.dd.DD"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "capture",
+ "name" : "getTotalCount",
"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"
+ "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"
},
{
- "name" : "clearConstraints",
+ "name" : "hasListener",
"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" : "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"
},
{
- "name" : "clearTicks",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "createFrame",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DDProxy"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "endDrag",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "fireEvent",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "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.util.Observable"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "getDragData",
+ "name" : "loadData",
"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)",
+ "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"
},
{
- "name" : "getDragEl",
+ "name" : "loadDataFromChildren",
"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}",
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "getEl",
+ "name" : "on",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
- "sig" : "()\n{\n\n}",
+ "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"
},
{
- "name" : "getProxy",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragSource"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "getRepairXY",
+ "name" : "query",
"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)",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "hasListener",
+ "name" : "queryBy",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "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"
},
{
- "name" : "hideProxy",
+ "name" : "rejectChanges",
"type" : "function",
- "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
+ "desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragSource"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "init",
+ "name" : "releaseCapture",
"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"
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "initFrame",
+ "name" : "reload",
"type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
- "sig" : "()\n{\n\n}",
+ "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.dd.DDProxy"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "initTarget",
+ "name" : "remove",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "isLocked",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "desc" : "Remove all Records from the Store and fires the clear event.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "isTarget",
+ "name" : "removeListener",
"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}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "isValidHandleChild",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "lock",
+ "name" : "sort",
"type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
+ "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.dd.DragDrop"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "on",
+ "name" : "sum",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "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.util.Observable"
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "onAvailable",
+ "name" : "un",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- },
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.data.SortTypes" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "onBeforeDrag",
+ "name" : "asDate",
"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"
+ "desc" : "Date sorting",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : ""
},
{
- "name" : "onDrag",
+ "name" : "asFloat",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Float sorting",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : ""
},
{
- "name" : "onDragDrop",
+ "name" : "asInt",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Integer sorting",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : ""
},
{
- "name" : "onDragEnter",
+ "name" : "asText",
"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"
+ "desc" : "Strips all HTML tags to sort on text only",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : ""
},
{
- "name" : "onDragOut",
+ "name" : "asUCString",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Case insensitive string",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : ""
},
{
- "name" : "onDragOver",
+ "name" : "asUCText",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : ""
},
{
- "name" : "onInitDrag",
+ "name" : "none",
"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,
+ "desc" : "Default sort that does nothing",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "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" : ""
},
{
- "name" : "onInvalidDrop",
- "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"
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "Inline data to be loaded when the store is initialized.",
+ "memberOf" : ""
},
{
- "name" : "onMouseDown",
+ "name" : "isLocal",
+ "type" : "boolean",
+ "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "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" : "multiSort",
+ "type" : "Boolean",
+ "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "The Proxy object which provides access to a data object.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "pruneModifiedRecords",
+ "type" : "boolean",
+ "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.Reader",
+ "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "remoteSort",
+ "type" : "boolean",
+ "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "sortInfo",
+ "type" : "Object",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [
+ {
+ "name" : "add",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "onMouseUp",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "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" : ""
},
{
- "name" : "onStartDrag",
+ "name" : "beforeloadadd",
"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"
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "padding",
+ "name" : "clear",
"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" : "Roo.dd.DragDrop"
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "purgeListeners",
+ "name" : "datachanged",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "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" : ""
},
{
- "name" : "releaseCapture",
+ "name" : "load",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "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" : ""
},
{
- "name" : "removeFromGroup",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "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" : ""
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "metachange",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "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" : ""
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "remove",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "update",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : ""
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "removeListener",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "resetConstraints",
+ "name" : "addListener",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "setDelta",
+ "name" : "capture",
"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"
+ "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"
},
{
- "name" : "setDragElId",
+ "name" : "clearFilter",
"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" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setDragElPos",
+ "name" : "collect",
"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)",
+ "desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
"static" : false,
- "memberOf" : "Roo.dd.DD"
+ "memberOf" : ""
},
{
- "name" : "setHandleElId",
+ "name" : "commitChanges",
"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" : "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setInitPosition",
+ "name" : "each",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setOuterHandleElId",
+ "name" : "filter",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setPadding",
+ "name" : "filterBy",
"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" : "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "setXConstraint",
+ "name" : "fireEvent",
"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" : "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"
},
{
- "name" : "setYConstraint",
+ "name" : "getAt",
"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" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "startDrag",
+ "name" : "getById",
"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" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "toString",
+ "name" : "getCount",
"type" : "function",
- "desc" : "toString method",
+ "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.dd.DragDrop"
+ "memberOf" : ""
},
{
- "name" : "un",
+ "name" : "getModifiedRecords",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "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" : ""
+ },
+ {
+ "name" : "getRange",
+ "type" : "function",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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"
},
{
- "name" : "unlock",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Unlock this instace",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "indexOfId",
+ "type" : "function",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "insert",
+ "type" : "function",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "load",
+ "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)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "loadData",
+ "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)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "loadDataFromChildren",
+ "type" : "function",
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "unreg",
+ "name" : "query",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "rejectChanges",
+ "type" : "function",
+ "desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- }
- ]
- },
- "Roo.dd.DropTarget" : {
- "props" : [
+ "memberOf" : ""
+ },
{
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "The drag drop group to handle drop events for",
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "reload",
+ "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)",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "name" : "removeAll",
+ "type" : "function",
+ "desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "setDefaultSort",
+ "type" : "function",
+ "desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
+ "static" : false,
"memberOf" : ""
},
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.data.Tree" : {
+ "props" : [
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "append",
+ "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" : ""
},
{
- "name" : "overClass",
- "type" : "String",
- "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
+ "name" : "beforeappend",
+ "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" : ""
},
{
- "name" : "success",
- "type" : "boolean",
- "desc" : "set this after drop listener..",
+ "name" : "beforeinsert",
+ "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" : ""
},
{
- "name" : "valid",
- "type" : "boolean|String",
- "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
+ "name" : "beforemove",
+ "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" : ""
+ },
+ {
+ "name" : "beforeremove",
+ "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" : ""
+ },
+ {
+ "name" : "insert",
+ "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" : ""
+ },
+ {
+ "name" : "move",
+ "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" : ""
+ },
+ {
+ "name" : "remove",
+ "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" : ""
}
],
- "events" : [
+ "methods" : [
{
- "name" : "drop",
+ "name" : "addEvents",
"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}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "getNodeById",
+ "type" : "function",
+ "desc" : "Gets a node in this tree by its id.",
+ "sig" : "(id)",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "enter",
+ "name" : "getRootNode",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed",
- "sig" : "function (source, e, data)\n{\n\n}",
+ "desc" : "Returns the root node for this tree.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "out",
+ "name" : "hasListener",
"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}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "setRootNode",
+ "type" : "function",
+ "desc" : "Sets the root node for this tree.",
+ "sig" : "(node)",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "over",
+ "name" : "un",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed",
- "sig" : "function (source, e, data)\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "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" : ""
+ },
+ {
+ "name" : "record",
+ "type" : "String",
+ "desc" : "The DomQuery path to the repeated element which contains record information.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "success",
+ "type" : "String",
+ "desc" : "The DomQuery path to the success attribute used by forms.",
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
+ "type" : "function",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "Roo.data.DataReader"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "readRecords",
+ "type" : "function",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(doc)",
+ "static" : false,
"memberOf" : ""
}
+ ]
+ },
+ "Roo.dd" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "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"
+ }
],
+ "events" : [],
"methods" : [
{
"name" : "addEvents",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
+ {
+ "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" : ""
+ },
{
"name" : "applyConfig",
"type" : "function",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
- {
- "name" : "notifyDrop",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "notifyEnter",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "notifyOut",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "notifyOver",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
+ {
+ "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" : ""
+ },
{
"name" : "setDragElId",
"type" : "function",
"memberOf" : "Roo.dd.DragDrop"
},
{
- "name" : "setHandleElId",
+ "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" : ""
+ },
+ {
+ "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)",
}
]
},
- "Roo.dd.DropZone" : {
+ "Roo.dd.DDProxy" : {
"props" : [
- {
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "The drag drop group to handle drop events for",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "Roo.dd.DropTarget"
- },
{
"name" : "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" : "overClass",
- "type" : "String",
- "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "success",
- "type" : "boolean",
- "desc" : "set this after drop listener..",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "valid",
- "type" : "boolean|String",
- "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
- "memberOf" : "Roo.dd.DropTarget"
- }
- ],
- "events" : [
- {
- "name" : "drop",
- "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"
- },
- {
- "name" : "enter",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "out",
- "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"
- },
- {
- "name" : "over",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget"
}
],
+ "events" : [],
"methods" : [
{
"name" : "addEvents",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
+ {
+ "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"
+ },
{
"name" : "applyConfig",
"type" : "function",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
+ {
+ "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"
+ },
+ {
+ "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"
+ },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
+ {
+ "name" : "createFrame",
+ "type" : "function",
+ "desc" : "Creates the proxy element if it does not yet exist",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "endDrag",
"type" : "function",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
- {
- "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" : ""
- },
{
"name" : "hasListener",
"type" : "function",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
+ {
+ "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" : ""
+ },
{
"name" : "initTarget",
"type" : "function",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
- {
- "name" : "notifyDrop",
- "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" : ""
- },
- {
- "name" : "notifyEnter",
- "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,
- "memberOf" : ""
- },
- {
- "name" : "notifyOut",
- "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" : ""
- },
- {
- "name" : "notifyOver",
- "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,
- "memberOf" : ""
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.dd.DragDrop"
},
- {
- "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" : ""
- },
- {
- "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" : ""
- },
{
"name" : "onDrag",
"type" : "function",
"memberOf" : "Roo.dd.DragDrop"
},
{
- "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,
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleId",
+ "type" : "function",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "resetConstraints",
+ "type" : "function",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setInitPosition",
+ "type" : "function",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setOuterHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setPadding",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setXConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setYConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "startDrag",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ }
+ ]
+ },
+ "Roo.dd.DDTarget" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "clearConstraints",
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "clearTicks",
+ "type" : "function",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "initTarget",
+ "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"
+ },
+ {
+ "name" : "isLocked",
+ "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"
+ },
+ {
+ "name" : "isTarget",
+ "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"
+ },
+ {
+ "name" : "isValidHandleChild",
+ "type" : "function",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "onAvailable",
+ "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"
+ },
+ {
+ "name" : "onDrag",
+ "type" : "function",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragDrop",
+ "type" : "function",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragEnter",
+ "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"
+ },
+ {
+ "name" : "onDragOut",
+ "type" : "function",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragOver",
+ "type" : "function",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onInvalidDrop",
+ "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"
+ },
+ {
+ "name" : "onMouseDown",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onMouseUp",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleId",
+ "type" : "function",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "resetConstraints",
+ "type" : "function",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setInitPosition",
+ "type" : "function",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setOuterHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setPadding",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setXConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setYConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "startDrag",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ }
+ ]
+ },
+ "Roo.dd.DragDrop" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "addInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "clearConstraints",
+ "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" : ""
+ },
+ {
+ "name" : "clearTicks",
+ "type" : "function",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "initTarget",
+ "type" : "function",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "isLocked",
+ "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" : ""
+ },
+ {
+ "name" : "isTarget",
+ "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" : ""
+ },
+ {
+ "name" : "isValidHandleChild",
+ "type" : "function",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "onAvailable",
+ "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" : ""
+ },
+ {
+ "name" : "onDrag",
+ "type" : "function",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "onDragDrop",
+ "type" : "function",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "onDragEnter",
+ "type" : "function",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "onDragOut",
+ "type" : "function",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "onDragOver",
+ "type" : "function",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "onInvalidDrop",
+ "type" : "function",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "onMouseDown",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "onMouseUp",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "removeInvalidHandleId",
+ "type" : "function",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "resetConstraints",
+ "type" : "function",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "setInitPosition",
+ "type" : "function",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setOuterHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setPadding",
+ "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)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setXConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setYConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "startDrag",
+ "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)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.dd.DragDropMgr" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getBestMatch",
+ "type" : "function",
+ "desc" : "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode. It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element.",
+ "sig" : "(dds)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getCss",
+ "type" : "function",
+ "desc" : "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getDDById",
+ "type" : "function",
+ "desc" : "Returns the DragDrop instance for a given id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getElement",
+ "type" : "function",
+ "desc" : "Returns the actual DOM element",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getLocation",
+ "type" : "function",
+ "desc" : "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it",
+ "sig" : "(oDD)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getPosX",
+ "type" : "function",
+ "desc" : "Returns the X position of an html element",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getPosY",
+ "type" : "function",
+ "desc" : "Returns the Y position of an html element",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getRelated",
+ "type" : "function",
+ "desc" : "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to.",
+ "sig" : "(p_oDD, bTargetsOnly)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getScrollLeft",
+ "type" : "function",
+ "desc" : "Gets the scrollLeft",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getScrollTop",
+ "type" : "function",
+ "desc" : "Gets the scrollTop",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getStyle",
+ "type" : "function",
+ "desc" : "Returns the specified element style property",
+ "sig" : "(el, styleProp)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "handleWasClicked",
+ "type" : "function",
+ "desc" : "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked.",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "isDragDrop",
+ "type" : "function",
+ "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop item.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "isHandle",
+ "type" : "function",
+ "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "isLegalTarget",
+ "type" : "function",
+ "desc" : "Returns true if the specified dd target is a legal target for\nthe specifice drag obj",
+ "sig" : "(the, the)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "isLocked",
+ "type" : "function",
+ "desc" : "Is drag and drop locked?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "isTypeOfDD",
+ "type" : "function",
+ "desc" : "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop.",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock all drag and drop functionality",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "moveToEl",
+ "type" : "function",
+ "desc" : "Sets the x/y position of an element to the location of the\ntarget element.",
+ "sig" : "(moveEl, targetEl)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "numericSort",
+ "type" : "function",
+ "desc" : "Numeric array sort function",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "refreshCache",
+ "type" : "function",
+ "desc" : "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n<code>\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n</code>\nAlternatively:\n<code>\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n</code>",
+ "sig" : "(groups)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "regDragDrop",
+ "type" : "function",
+ "desc" : "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()",
+ "sig" : "(oDD, sGroup)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "regHandle",
+ "type" : "function",
+ "desc" : "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()",
+ "sig" : "(sDDId, sHandleId)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "startDrag",
+ "type" : "function",
+ "desc" : "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "stopEvent",
+ "type" : "function",
+ "desc" : "Utility to stop event propagation and event default, if these\nfeatures are turned on.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "swapNode",
+ "type" : "function",
+ "desc" : "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior",
+ "sig" : "(n1, n2)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock all drag and drop functionality",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "verifyEl",
+ "type" : "function",
+ "desc" : "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.dd.DragSource" : {
+ "props" : [
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : ""
+ },
+ {
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "clearConstraints",
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "clearTicks",
+ "type" : "function",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "getDragData",
+ "type" : "function",
+ "desc" : "Returns the data object associated with this drag source",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "getProxy",
+ "type" : "function",
+ "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "hideProxy",
+ "type" : "function",
+ "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "initTarget",
+ "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"
+ },
+ {
+ "name" : "isLocked",
+ "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"
+ },
+ {
+ "name" : "isTarget",
+ "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"
+ },
+ {
+ "name" : "isValidHandleChild",
+ "type" : "function",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "onAvailable",
+ "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"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "onDrag",
+ "type" : "function",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragDrop",
+ "type" : "function",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragEnter",
+ "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"
+ },
+ {
+ "name" : "onDragOut",
+ "type" : "function",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragOver",
+ "type" : "function",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onInvalidDrop",
+ "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"
+ },
+ {
+ "name" : "onMouseDown",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onMouseUp",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleId",
+ "type" : "function",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "resetConstraints",
+ "type" : "function",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setInitPosition",
+ "type" : "function",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setOuterHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setPadding",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setXConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setYConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "startDrag",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ }
+ ]
+ },
+ "Roo.dd.DragZone" : {
+ "props" : [
+ {
+ "name" : "containerScroll",
+ "type" : "Boolean",
+ "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "Roo.dd.DragSource"
+ },
+ {
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : "Roo.dd.DragSource"
+ },
+ {
+ "name" : "hlColor",
+ "type" : "String",
+ "desc" : "The color to use when visually highlighting the drag source in the afterRepair\nmethod after a failed drop (defaults to \"c3daf9\" - light blue)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragSource"
+ },
+ {
+ "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" : "Roo.dd.DragSource"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragSource"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "clearConstraints",
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "clearTicks",
+ "type" : "function",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "hideProxy",
+ "type" : "function",
+ "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "initTarget",
+ "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"
+ },
+ {
+ "name" : "isLocked",
+ "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"
+ },
+ {
+ "name" : "isTarget",
+ "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"
+ },
+ {
+ "name" : "isValidHandleChild",
+ "type" : "function",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "onAvailable",
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "onDrag",
+ "type" : "function",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragDrop",
+ "type" : "function",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragEnter",
+ "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"
+ },
+ {
+ "name" : "onDragOut",
+ "type" : "function",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragOver",
+ "type" : "function",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "onInvalidDrop",
+ "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"
+ },
+ {
+ "name" : "onMouseDown",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onMouseUp",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleId",
+ "type" : "function",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "resetConstraints",
+ "type" : "function",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setInitPosition",
+ "type" : "function",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setOuterHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setPadding",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setXConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setYConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "startDrag",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ }
+ ]
+ },
+ "Roo.dd.DropTarget" : {
+ "props" : [
+ {
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "The drag drop group to handle drop events for",
+ "memberOf" : ""
+ },
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : ""
+ },
+ {
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "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" : "overClass",
+ "type" : "String",
+ "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
+ "memberOf" : ""
+ },
+ {
+ "name" : "success",
+ "type" : "boolean",
+ "desc" : "set this after drop listener..",
+ "memberOf" : ""
+ },
+ {
+ "name" : "valid",
+ "type" : "boolean|String",
+ "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [
+ {
+ "name" : "drop",
+ "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" : ""
+ },
+ {
+ "name" : "enter",
+ "type" : "function",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "out",
+ "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" : ""
+ },
+ {
+ "name" : "over",
+ "type" : "function",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : ""
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "clearConstraints",
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "clearTicks",
+ "type" : "function",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "initTarget",
+ "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"
+ },
+ {
+ "name" : "isLocked",
+ "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"
+ },
+ {
+ "name" : "isTarget",
+ "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"
+ },
+ {
+ "name" : "isValidHandleChild",
+ "type" : "function",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "notifyDrop",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "notifyEnter",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "notifyOut",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "notifyOver",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "onAvailable",
+ "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"
+ },
+ {
+ "name" : "onDrag",
+ "type" : "function",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragDrop",
+ "type" : "function",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragEnter",
+ "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"
+ },
+ {
+ "name" : "onDragOut",
+ "type" : "function",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragOver",
+ "type" : "function",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onInvalidDrop",
+ "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"
+ },
+ {
+ "name" : "onMouseDown",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onMouseUp",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleId",
+ "type" : "function",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "resetConstraints",
+ "type" : "function",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setInitPosition",
+ "type" : "function",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setOuterHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setPadding",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setXConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setYConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "startDrag",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ }
+ ]
+ },
+ "Roo.dd.DropZone" : {
+ "props" : [
+ {
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "The drag drop group to handle drop events for",
+ "memberOf" : "Roo.dd.DropTarget"
+ },
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "Roo.dd.DropTarget"
+ },
+ {
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : "Roo.dd.DropTarget"
+ },
+ {
+ "name" : "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" : "overClass",
+ "type" : "String",
+ "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
+ "memberOf" : "Roo.dd.DropTarget"
+ },
+ {
+ "name" : "success",
+ "type" : "boolean",
+ "desc" : "set this after drop listener..",
+ "memberOf" : "Roo.dd.DropTarget"
+ },
+ {
+ "name" : "valid",
+ "type" : "boolean|String",
+ "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
+ "memberOf" : "Roo.dd.DropTarget"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "drop",
+ "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"
+ },
+ {
+ "name" : "enter",
+ "type" : "function",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.overClass and this.dropAllowed",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "Roo.dd.DropTarget"
+ },
+ {
+ "name" : "out",
+ "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"
+ },
+ {
+ "name" : "over",
+ "type" : "function",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.dropAllowed",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "Roo.dd.DropTarget"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "clearConstraints",
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "clearTicks",
+ "type" : "function",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "initTarget",
+ "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"
+ },
+ {
+ "name" : "isLocked",
+ "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"
+ },
+ {
+ "name" : "isTarget",
+ "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"
+ },
+ {
+ "name" : "isValidHandleChild",
+ "type" : "function",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "notifyDrop",
+ "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" : ""
+ },
+ {
+ "name" : "notifyEnter",
+ "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,
+ "memberOf" : ""
+ },
+ {
+ "name" : "notifyOut",
+ "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" : ""
+ },
+ {
+ "name" : "notifyOver",
+ "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,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "onAvailable",
+ "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"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "onDrag",
+ "type" : "function",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragDrop",
+ "type" : "function",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragEnter",
+ "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"
+ },
+ {
+ "name" : "onDragOut",
+ "type" : "function",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onDragOver",
+ "type" : "function",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onInvalidDrop",
+ "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"
+ },
+ {
+ "name" : "onMouseDown",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "onMouseUp",
+ "type" : "function",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeFromGroup",
+ "type" : "function",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleId",
+ "type" : "function",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeInvalidHandleType",
+ "type" : "function",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "resetConstraints",
+ "type" : "function",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "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" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setInitPosition",
+ "type" : "function",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setOuterHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setPadding",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setXConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "setYConstraint",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "startDrag",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop"
+ }
+ ]
+ },
+ "Roo.dd.Registry" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getHandle",
+ "type" : "function",
+ "desc" : "Returns the handle registered for a DOM Node by id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getHandleFromEvent",
+ "type" : "function",
+ "desc" : "Returns the handle that is registered for the DOM node that is the target of the event",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getTarget",
+ "type" : "function",
+ "desc" : "Returns a custom data object that is registered for a DOM node by id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "Register a drag drop element",
+ "sig" : "(element, data)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "unregister",
+ "type" : "function",
+ "desc" : "Unregister a drag drop element",
+ "sig" : "(element)",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.dd.ScrollManager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "refreshCache",
+ "type" : "function",
+ "desc" : "Manually trigger a cache refresh.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "Registers new overflow element(s) to auto scroll",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "unregister",
+ "type" : "function",
+ "desc" : "Unregisters overflow element(s) so they are no longer scrolled",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "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" : ""
+ },
+ {
+ "name" : "dropNotAllowed",
+ "type" : "String",
+ "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying proxy {@link Roo.Layer}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getGhost",
+ "type" : "function",
+ "desc" : "Returns the ghost element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides the proxy",
+ "sig" : "(clear)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "repair",
+ "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)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the status indicator to the default dropNotAllowed value",
+ "sig" : "(clearGhost)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Displays this proxy",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "stop",
+ "type" : "function",
+ "desc" : "Stops the repair animation if it's currently running",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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" : ""
+ },
+ {
+ "name" : "update",
+ "type" : "function",
+ "desc" : "Updates the contents of the ghost element",
+ "sig" : "(html)",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.form" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.form.Action" : {
+ "props" : [],
+ "events" : [],
+ "methods" : []
+ },
+ "Roo.form.BasicForm" : {
+ "props" : [
+ {
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "errorMask",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "errorReader",
+ "type" : "DataReader",
+ "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "fileUpload",
+ "type" : "Boolean",
+ "desc" : "Set to true if this form is a file upload.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "maskOffset",
+ "type" : "Number",
+ "desc" : "Default 100",
+ "memberOf" : ""
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "reader",
+ "type" : "DataReader",
+ "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "trackResetOnLoad",
+ "type" : "Boolean",
+ "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [
+ {
+ "name" : "actioncomplete",
+ "type" : "function",
+ "desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "actionfailed",
+ "type" : "function",
+ "desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "beforeaction",
+ "type" : "function",
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : ""
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add Roo.form components to this form.",
+ "sig" : "(field1, field2, etc)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "addForm",
+ "type" : "function",
+ "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
+ "sig" : "(form)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "applyIfToFields",
+ "type" : "function",
+ "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "applyToFields",
+ "type" : "function",
+ "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clears all invalid messages in this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "doAction",
+ "type" : "function",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "findField",
+ "type" : "function",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "getFieldValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "getValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns true if client-side validation on the form is successful.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Shortcut to do a load action.",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "loadRecord",
+ "type" : "function",
+ "desc" : "Loads an Roo.data.Record into this form.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Removes a field from the items collection (does NOT remove its markup).",
+ "sig" : "(field)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setValues",
+ "type" : "function",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "submit",
+ "type" : "function",
+ "desc" : "Shortcut to do a submit action.",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "updateRecord",
+ "type" : "function",
+ "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.form.Checkbox" : {
+ "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" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf" : ""
+ },
+ {
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "The text that appears beside the checkbox",
+ "memberOf" : ""
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "inputValue",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value attribute",
+ "memberOf" : ""
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "valueOff",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value when unchecked.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
+ }
+ ],
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "check",
+ "type" : "function",
+ "desc" : "Fires when the checkbox is checked or unchecked.",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "applyTo",
+ "type" : "function",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the checked state of the checkbox.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "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.BoxComponent"
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "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.BoxComponent"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "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" : ""
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ }
+ ]
+ },
+ "Roo.form.Column" : {
+ "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" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec used to autocreate the column (defaults to {tag: 'div', cls: 'x-form-ct x-form-column'})",
+ "memberOf" : ""
+ },
+ {
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : "Roo.form.Layout"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hideLabels",
+ "type" : "Boolean",
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "Roo.form.Layout"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf" : "Roo.form.Layout"
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "Roo.form.Layout"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "Roo.form.Layout"
+ },
+ {
+ "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" : "style",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf" : "Roo.form.Layout"
+ },
+ {
+ "name" : "width",
+ "type" : "Number/String",
+ "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf" : ""
+ }
+ ],
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "Roo.form.Layout"
+ },
+ {
+ "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"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "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"
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ }
+ ]
+ },
+ "Roo.form.ComboBox" : {
+ "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" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : ""
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : ""
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : ""
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : ""
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : ""
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : ""
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "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.form.TextField"
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : ""
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : ""
+ },
+ {
+ "name" : "transform",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf" : ""
+ },
+ {
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "typeAhead",
+ "type" : "Boolean",
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "typeAheadDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "valueField",
+ "type" : "String",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
"memberOf" : ""
},
{
- "name" : "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,
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
"memberOf" : ""
},
{
- "name" : "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" : ""
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "onNodeOver",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "add",
"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,
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "padding",
+ "name" : "autosize",
"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" : "Roo.dd.DragDrop"
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "purgeListeners",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "releaseCapture",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "removeFromGroup",
+ "name" : "beforequery",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "removeListener",
+ "name" : "blur",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "resetConstraints",
+ "name" : "change",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "setDragElId",
+ "name" : "collapse",
"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" : "Roo.dd.DragDrop"
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "setHandleElId",
+ "name" : "destroy",
"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" : "Roo.dd.DragDrop"
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setInitPosition",
+ "name" : "disable",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setOuterHandleElId",
+ "name" : "edit",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "setPadding",
+ "name" : "enable",
"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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "setXConstraint",
+ "name" : "expand",
"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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "setYConstraint",
+ "name" : "focus",
"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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "startDrag",
+ "name" : "hide",
"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)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "toString",
+ "name" : "invalid",
"type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "un",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "unlock",
+ "name" : "move",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "unreg",
- "type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop"
- }
- ]
- },
- "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)",
- "static" : false,
- "memberOf" : ""
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getHandleFromEvent",
+ "name" : "resize",
"type" : "function",
- "desc" : "Returns the handle that is registered for the DOM node that is the target of the event",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : ""
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "getTarget",
+ "name" : "select",
"type" : "function",
- "desc" : "Returns a custom data object that is registered for a DOM node by id",
- "sig" : "(id)",
- "static" : false,
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
"memberOf" : ""
},
{
- "name" : "getTargetFromEvent",
+ "name" : "show",
"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" : ""
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "register",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Register a drag drop element",
- "sig" : "(element, data)",
- "static" : false,
- "memberOf" : ""
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "unregister",
+ "name" : "valid",
"type" : "function",
- "desc" : "Unregister a drag drop element",
- "sig" : "(element)",
- "static" : false,
- "memberOf" : ""
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
}
- ]
- },
- "Roo.dd.ScrollManager" : {
- "props" : [
- ],
- "events" : [
],
"methods" : [
{
- "name" : "refreshCache",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Manually trigger a cache refresh.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "register",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Registers new overflow element(s) to auto scroll",
- "sig" : "(el)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "unregister",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Unregisters overflow element(s) so they are no longer scrolled",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
"sig" : "(el)",
"static" : false,
- "memberOf" : ""
- }
- ]
- },
- "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" : ""
- },
- {
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : ""
- }
- ],
- "events" : [
- ],
- "methods" : [
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying proxy {@link Roo.Layer}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "getGhost",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Returns the ghost element",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides the proxy",
- "sig" : "(clear)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "repair",
- "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)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the status indicator to the default dropNotAllowed value",
- "sig" : "(clearGhost)",
- "static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.TriggerField"
},
{
- "name" : "setStatus",
+ "name" : "capture",
"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" : ""
+ "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"
},
{
- "name" : "show",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Displays this proxy",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "stop",
+ "name" : "clearValue",
"type" : "function",
- "desc" : "Stops the repair animation if it's currently running",
+ "desc" : "Clears any text/value currently set in the field",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "sync",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Force the Layer to sync its shadow and shim positions to the element",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "update",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Updates the contents of the ghost element",
- "sig" : "(html)",
+ "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.form" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
- },
- "Roo.form.Action" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
- },
- "Roo.form.BasicForm" : {
- "props" : [
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : ""
- },
- {
- "name" : "errorReader",
- "type" : "DataReader",
- "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
- "memberOf" : ""
- },
- {
- "name" : "fileUpload",
- "type" : "Boolean",
- "desc" : "Set to true if this form is a file upload.",
- "memberOf" : ""
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "method",
- "type" : "String",
- "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
- "memberOf" : ""
- },
- {
- "name" : "reader",
- "type" : "DataReader",
- "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
- "memberOf" : ""
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : ""
- },
- {
- "name" : "trackResetOnLoad",
- "type" : "Boolean",
- "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
- "memberOf" : ""
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : ""
- }
- ],
- "events" : [
- {
- "name" : "actioncomplete",
- "type" : "function",
- "desc" : "Fires when an action is completed.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "actionfailed",
- "type" : "function",
- "desc" : "Fires when an action fails.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "beforeaction",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : ""
- }
- ],
- "methods" : [
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
{
- "name" : "add",
+ "name" : "doQuery",
"type" : "function",
- "desc" : "Add Roo.form components to this form.",
- "sig" : "(field1, field2, etc)",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "addEvents",
+ "name" : "enable",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "addForm",
+ "name" : "expand",
"type" : "function",
- "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
- "sig" : "(form)",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "addListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "applyIfToFields",
+ "name" : "focus",
"type" : "function",
- "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "applyToFields",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "capture",
+ "name" : "getEl",
"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"
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "clearInvalid",
+ "name" : "getId",
"type" : "function",
- "desc" : "Clears all invalid messages in this form.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "doAction",
+ "name" : "getName",
"type" : "function",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
- "sig" : "(actionName, options)",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "findField",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
- "sig" : "(id)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "fireEvent",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "getFieldValues",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "getValues",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
- "sig" : "(asString)",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
"name" : "hasChanged",
"type" : "function",
- "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "hasListener",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
{
"name" : "isDirty",
"type" : "function",
- "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "isValid",
+ "name" : "isExpanded",
"type" : "function",
- "desc" : "Returns true if client-side validation on the form is successful.",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
},
{
- "name" : "load",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Shortcut to do a load action.",
- "sig" : "(options)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "loadRecord",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Loads an Roo.data.Record into this form.",
- "sig" : "(record)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark fields in this form invalid in bulk.",
- "sig" : "(errors)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "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.BoxComponent"
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "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.BoxComponent"
+ },
+ {
+ "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.form.TriggerField"
+ },
{
"name" : "purgeListeners",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Removes a field from the items collection (does NOT remove its markup).",
- "sig" : "(field)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "removeListener",
"type" : "function",
{
"name" : "render",
"type" : "function",
- "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets this form.",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "resetHasChanged",
"type" : "function",
- "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
+ "desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
"memberOf" : ""
},
{
- "name" : "setValues",
+ "name" : "selectByValue",
"type" : "function",
- "desc" : "Set values for fields in this form in bulk.",
- "sig" : "(values)",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "submit",
+ "name" : "selectText",
"type" : "function",
- "desc" : "Shortcut to do a submit action.",
- "sig" : "(options)",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
"static" : false,
"memberOf" : ""
},
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
{
"name" : "un",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "updateRecord",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
- "sig" : "(record)",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
}
]
},
- "Roo.form.Checkbox" : {
+ "Roo.form.ComboBoxArray" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : ""
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "boxLabel",
+ "name" : "blankText",
"type" : "String",
- "desc" : "The text that appears beside the checkbox",
- "memberOf" : ""
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "True if the the checkbox should render already checked (defaults to false)",
- "memberOf" : ""
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "cls",
"desc" : "A CSS class to apply to the field's underlying element.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "combo",
+ "type" : "Roo.form.Combo",
+ "desc" : "The combo box that is wrapped",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "fieldLabel",
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "height",
"desc" : "height (optional) size of component",
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "The hidden name of the field, often contains an comma seperated list of names",
+ "memberOf" : ""
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "inputValue",
- "type" : "String",
- "desc" : "The value that should go into the generated input element's value attribute",
- "memberOf" : ""
- },
{
"name" : "invalidClass",
"type" : "String",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "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.form.TextField"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
{
"name" : "msgFx",
"type" : "String",
{
"name" : "name",
"type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The name of the visable items on this form (eg. titles not ids)",
+ "memberOf" : ""
},
{
"name" : "qtip",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "seperator",
+ "type" : "String",
+ "desc" : "The value seperator normally ','",
+ "memberOf" : ""
+ },
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf" : "Roo.form.Field"
},
+ {
+ "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.form.TextField"
+ },
{
"name" : "value",
"type" : "Mixed",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "valueOff",
+ "name" : "vtype",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : ""
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "width",
"type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "The width of the box that displays the selected element",
+ "memberOf" : ""
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforeremove",
+ "type" : "function",
+ "desc" : "Fires before remove the value from the list",
+ "sig" : "function (_self, item)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforerender",
"type" : "function",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the checkbox is checked or unchecked.",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self, x, y)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when remove the value from the list",
+ "sig" : "function (_self, item)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "render",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "capture",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the checked state of the checkbox.",
+ "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" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "hasChanged",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "resetHasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
- "sig" : "(value, suppressEvent)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "setVisible",
{
"name" : "validate",
"type" : "function",
- "desc" : "Validates the field value",
+ "desc" : "Validates the combox array value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
+ },
+ {
+ "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.form.TextField"
}
]
},
- "Roo.form.Column" : {
+ "Roo.form.ComboBoxArray.Item" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the column (defaults to {tag: 'div', cls: 'x-form-ct x-form-column'})",
- "memberOf" : ""
- },
- {
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf" : "Roo.form.Layout"
- },
{
"name" : "disableClass",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideLabels",
- "type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout"
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "style",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf" : "Roo.form.Layout"
- },
{
"name" : "width",
- "type" : "Number/String",
- "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
}
],
"events" : [
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
+ },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
+ },
{
"name" : "show",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "Roo.form.Layout"
- },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
{
"name" : "getEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
{
"name" : "hasListener",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "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.BoxComponent"
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "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.BoxComponent"
+ },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
{
"name" : "setVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
{
"name" : "un",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
}
]
},
- "Roo.form.ComboBox" : {
+ "Roo.form.ComboCheck" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allQuery",
"type" : "String",
"desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "allowBlank",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "alwaysQuery",
"type" : "Boolean",
"desc" : "Disable caching of results, and always send query",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "autoCreate",
"type" : "Boolean/Object",
"desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "blankText",
"name" : "blockFocus",
"type" : "Boolean",
"desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "cls",
"name" : "disableClear",
"type" : "Boolean",
"desc" : "Disable showing of clear button.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "disableKeyFilter",
"name" : "displayField",
"type" : "String",
"desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "editable",
"type" : "Boolean",
"desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "emptyText",
"name" : "forceSelection",
"type" : "Boolean",
"desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "grow",
"type" : "Boolean",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "growMax",
"type" : "Number",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "handleHeight",
"type" : "Number",
"desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "height",
"name" : "hiddenName",
"type" : "String",
"desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideTrigger",
"name" : "lazyRender",
"type" : "Boolean",
"desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "listAlign",
"type" : "String",
"desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "listClass",
"type" : "String",
"desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "listWidth",
"type" : "Number",
"desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "listeners",
"name" : "loadingText",
"type" : "String",
"desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "maskRe",
"name" : "maxHeight",
"type" : "Number",
"desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "maxLength",
"name" : "minChars",
"type" : "Number",
"desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "minLength",
"name" : "minListWidth",
"type" : "Number",
"desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "mode",
"type" : "String",
"desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "msgFx",
"name" : "pageSize",
"type" : "Number",
"desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "qtip",
"name" : "queryDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "queryParam",
"type" : "String",
"desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "readOnly",
"name" : "resizable",
"type" : "Boolean",
"desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "selectedClass",
"type" : "String",
"desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "shadow",
"type" : "Boolean/String",
"desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "tabIndex",
"name" : "title",
"type" : "String",
"desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "tpl",
"type" : "String/Roo.Template",
"desc" : "The template to use to render the output",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "transform",
"type" : "String/HTMLElement/Element",
"desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "triggerAction",
"type" : "String",
"desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "triggerClass",
"type" : "String",
"desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "typeAhead",
"type" : "Boolean",
"desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "typeAheadDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "validateOnBlur",
"name" : "valueField",
"type" : "String",
"desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "valueNotFoundText",
"type" : "String",
"desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "vtype",
"type" : "function",
"desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
"sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "autosize",
"type" : "function",
"desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
"sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "beforerender",
"type" : "function",
"desc" : "Fires before a list item is selected. Return false to cancel the selection.",
"sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "beforeshow",
"type" : "function",
"desc" : "Fires when the dropdown list is collapsed",
"sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "destroy",
"type" : "function",
"desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
"sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "enable",
"type" : "function",
"desc" : "Fires when the dropdown list is expanded",
"sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "focus",
"type" : "function",
"desc" : "Fires when a list item is selected",
"sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "show",
"desc" : "Clears any text/value currently set in the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "collapse",
"desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "destroy",
"desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
"sig" : "(query, forceAll)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "enable",
"desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "fireEvent",
"desc" : "Returns the currently selected field value or empty string if no value is set.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "hasChanged",
"desc" : "Returns true if the dropdown list is expanded, else false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "isValid",
"desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
"sig" : "(index, scrollIntoView)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "selectByValue",
"desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
"sig" : "(value, scrollIntoView)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "selectText",
"desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
"sig" : "(value)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "setFromData",
"desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
"sig" : "(value)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "setPagePosition",
"desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
"sig" : "(value)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "setVisible",
}
]
},
- "Roo.form.ComboBoxArray" : {
+ "Roo.form.ComboNested" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field"
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "blankText",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
"memberOf" : "Roo.form.TextField"
},
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "combo",
- "type" : "Roo.form.Combo",
- "desc" : "The combo box that is wrapped",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "emptyText",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "grow",
"type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "growMax",
"type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "growMin",
"type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "height",
{
"name" : "hiddenName",
"type" : "String",
- "desc" : "The hidden name of the field, often contains an comma seperated list of names",
- "memberOf" : ""
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField"
},
{
"name" : "inputType",
"desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
"memberOf" : "Roo.form.TextField"
},
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
"memberOf" : "Roo.form.TextField"
},
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "minLength",
"type" : "Number",
"memberOf" : "Roo.form.TextField"
},
{
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "Roo.form.ComboBox"
},
{
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "name",
+ "name" : "title",
"type" : "String",
- "desc" : "The name of the visable items on this form (eg. titles not ids)",
- "memberOf" : ""
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf" : "Roo.form.ComboBox"
},
{
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : "Roo.form.ComboBox"
},
{
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
+ "name" : "transform",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf" : "Roo.form.ComboBox"
},
{
- "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.form.TextField"
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : "Roo.form.ComboBox"
},
{
- "name" : "regexText",
+ "name" : "triggerClass",
"type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
+ "memberOf" : "Roo.form.ComboBox"
},
{
- "name" : "selectOnFocus",
+ "name" : "typeAhead",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : "Roo.form.ComboBox"
},
{
- "name" : "tabIndex",
+ "name" : "typeAheadDelay",
"type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "validateOnBlur",
"desc" : "A value to initialize this field with.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "valueField",
+ "type" : "String",
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "vtype",
"type" : "String",
{
"name" : "width",
"type" : "Number",
- "desc" : "The width of the box that displays the selected element",
- "memberOf" : ""
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
}
],
"events" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "autosize",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "beforeremove",
+ "name" : "beforequery",
"type" : "function",
- "desc" : "Fires before remove the value from the list",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "beforerender",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "beforeshow",
"type" : "function",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "enable",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "focus",
"type" : "function",
"sig" : "function (_self, x, y)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when remove the value from the list",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "show",
"type" : "function",
{
"name" : "autoSize",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TriggerField"
},
{
"name" : "capture",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "fireEvent",
"type" : "function",
{
"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}.",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "hasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "isValid",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "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.form.TriggerField"
+ },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "selectText",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox"
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox"
+ },
{
"name" : "setPagePosition",
"type" : "function",
{
"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}.",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
"sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.ComboBox"
},
{
"name" : "setVisible",
{
"name" : "validate",
"type" : "function",
- "desc" : "Validates the combox array value",
+ "desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "validateValue",
}
]
},
- "Roo.form.ComboBoxArray.Item" : {
+ "Roo.form.DateField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "altFormats",
+ "type" : "String",
+ "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
+ "memberOf" : ""
+ },
+ {
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
+ "memberOf" : ""
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "disabledDates",
+ "type" : "Array",
+ "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
+ "memberOf" : ""
+ },
+ {
+ "name" : "disabledDatesText",
+ "type" : "String",
+ "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "disabledDays",
+ "type" : "Array",
+ "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "disabledDaysText",
+ "type" : "String",
+ "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "format",
+ "type" : "String",
+ "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "memberOf" : ""
+ },
{
"name" : "height",
"type" : "Number",
"memberOf" : "Roo.BoxComponent"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "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" : "Roo.form.TriggerField"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "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.form.TextField"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
+ "memberOf" : ""
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Date/String",
+ "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minValue",
+ "type" : "Date/String",
+ "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "useIso",
+ "type" : "Boolean",
+ "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field"
},
{
- "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" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "width",
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.Field"
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "move",
"type" : "function",
"sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (combo, date)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "show",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
}
],
"methods" : [
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "applyTo",
+ "type" : "function",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField"
+ },
{
"name" : "capture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "getPosition",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "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.form.Field"
+ },
{
"name" : "getSize",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the current date value of the date field.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "hasListener",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "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.form.TriggerField"
+ },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "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.form.Field"
+ },
{
"name" : "setSize",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n</code></pre>",
+ "sig" : "(date)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "setVisible",
"type" : "function",
"sig" : "(box)",
"static" : false,
"memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
}
]
},
- "Roo.form.ComboCheck" : {
+ "Roo.form.DayPicker" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField"
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "Roo.form.ComboBox"
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf" : ""
},
{
- "name" : "qtip",
+ "name" : "cls",
"type" : "String",
- "desc" : "Mouse over tip",
+ "desc" : "A CSS class to apply to the field's underlying element.",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "queryParam",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "readOnly",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
{
- "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.form.TextField"
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : ""
},
{
- "name" : "regexText",
+ "name" : "fieldLabel",
"type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : ""
},
{
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "selectedClass",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "Roo.form.ComboBox"
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox"
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "Roo.form.ComboBox"
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : "Roo.form.ComboBox"
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : "Roo.form.ComboBox"
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "triggerAction",
+ "name" : "name",
"type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "triggerClass",
+ "name" : "qtip",
"type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "typeAhead",
+ "name" : "readOnly",
"type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "typeAheadDelay",
+ "name" : "tabIndex",
"type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "validateOnBlur",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf" : "Roo.form.Field"
},
- {
- "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.form.TextField"
- },
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "width",
"type" : "Number",
}
],
"events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "beforerender",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "beforeshow",
"type" : "function",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "enable",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "focus",
"type" : "function",
"sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "show",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField"
- },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "desc" : "Returns the checked state of the checkbox.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : ""
},
{
"name" : "hasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "isValid",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "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.form.TriggerField"
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "resetHasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox"
- },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
+ "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.ComboBox"
+ "memberOf" : ""
},
{
"name" : "setVisible",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.form.Field"
- },
- {
- "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.form.TextField"
}
]
},
- "Roo.form.DateField" : {
+ "Roo.form.DisplayField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "altFormats",
- "type" : "String",
- "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
- "memberOf" : ""
- },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
"memberOf" : ""
},
{
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "",
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "disabledDates",
- "type" : "Array",
- "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
- "memberOf" : ""
- },
- {
- "name" : "disabledDatesText",
- "type" : "String",
- "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
- "memberOf" : ""
- },
- {
- "name" : "disabledDays",
- "type" : "Array",
- "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "disabledDaysText",
- "type" : "String",
- "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf" : ""
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : ""
},
{
"name" : "fieldLabel",
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "format",
- "type" : "String",
- "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
"memberOf" : ""
},
{
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
{
"name" : "invalidText",
"type" : "String",
- "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
- "memberOf" : ""
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "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.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
- "memberOf" : ""
- },
- {
- "name" : "maxValue",
- "type" : "Date/String",
- "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
- "memberOf" : ""
- },
- {
- "name" : "minValue",
- "type" : "Date/String",
- "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : ""
- },
{
"name" : "msgFx",
"type" : "String",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
"memberOf" : "Roo.form.Field"
},
- {
- "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.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
"memberOf" : "Roo.form.Field"
},
- {
- "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' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
- "memberOf" : ""
- },
- {
- "name" : "useIso",
- "type" : "Boolean",
- "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)",
- "memberOf" : ""
- },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf" : "Roo.form.Field"
},
- {
- "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.form.TextField"
- },
{
"name" : "value",
"type" : "Mixed",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "valueRenderer",
+ "type" : "Function",
+ "desc" : "The renderer for the field (so you can reformat output). should return raw HTML",
+ "memberOf" : ""
},
{
"name" : "width",
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "close",
+ "type" : "function",
+ "desc" : "Fires after the click the close btn",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (combo, date)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "show",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField"
- },
{
"name" : "capture",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the current date value of the date field.",
+ "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" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "hasChanged",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "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.form.TriggerField"
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "resetHasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n</code></pre>",
- "sig" : "(date)",
+ "desc" : "Sets the checked state of the checkbox.",
+ "sig" : "(checked)",
"static" : false,
"memberOf" : ""
},
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.form.Field"
- },
- {
- "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.form.TextField"
}
]
},
- "Roo.form.DayPicker" : {
+ "Roo.form.FCKeditor" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : ""
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.TextArea"
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "cls",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "disabled",
"type" : "Boolean",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "fieldClass",
+ "name" : "emptyText",
"type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "fck",
+ "type" : "Object",
+ "desc" : "BasePath",
"memberOf" : ""
},
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "fieldLabel",
"type" : "String",
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
+ "memberOf" : "Roo.form.TextArea"
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum height to allow when grow = true (defaults to 60)",
+ "memberOf" : "Roo.form.TextArea"
},
{
"name" : "height",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
{
"name" : "msgFx",
"type" : "String",
"desc" : "The field's HTML name attribute.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "preventScrollbars",
+ "type" : "Boolean",
+ "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
+ "memberOf" : "Roo.form.TextArea"
+ },
{
"name" : "qtip",
"type" : "String",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf" : "Roo.form.Field"
},
+ {
+ "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.form.TextField"
+ },
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "width",
"type" : "Number",
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "editorinit",
+ "type" : "function",
+ "desc" : "Fired when the editor is initialized - you can add extra handlers here..",
+ "sig" : "function (_self, the)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextArea"
+ },
{
"name" : "capture",
"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.form.Field"
+ "memberOf" : ""
},
{
"name" : "getSize",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the checked state of the checkbox.",
+ "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" : ""
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "resetHasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
- "sig" : "(value, suppressEvent)",
+ "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" : ""
},
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
}
]
},
- "Roo.form.DisplayField" : {
+ "Roo.form.Field" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : ""
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : [
- "(true",
- "false)"
- ],
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
"memberOf" : ""
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "disableClass",
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
"memberOf" : ""
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
"memberOf" : ""
},
{
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "listeners",
"name" : "msgFx",
"type" : "String",
"desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "msgTarget",
"type" : "String",
"desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "valueRenderer",
- "type" : "Function",
- "desc" : "The renderer for the field (so you can reformat output). should return raw HTML",
"memberOf" : ""
},
{
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"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.form.Field"
- },
- {
- "name" : "close",
- "type" : "function",
- "desc" : "Fires after the click the close btn",
- "sig" : "function (_self)\n{\n\n}",
"memberOf" : ""
},
{
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "hide",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "keyup",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "move",
"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.form.Field"
+ "memberOf" : ""
},
{
"name" : "valid",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
}
],
"methods" : [
"desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
"sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "capture",
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "destroy",
"desc" : "Returns the name attribute of the field if available",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "getPosition",
"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.form.Field"
+ "memberOf" : ""
},
{
"name" : "getSize",
"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.form.Field"
+ "memberOf" : ""
},
{
"name" : "hasChanged",
"desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "hasListener",
"desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "isValid",
"desc" : "Returns whether or not the field value is currently valid",
"sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "isVisible",
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "on",
"desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "resetHasChanged",
"desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "setDisabled",
"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.form.Field"
+ "memberOf" : ""
},
{
"name" : "setSize",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.",
- "sig" : "(checked)",
+ "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" : ""
},
"desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
}
]
},
- "Roo.form.FCKeditor" : {
+ "Roo.form.FieldSet" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.TextArea"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
+ "memberOf" : ""
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "disableClass",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableKeyFilter",
+ "name" : "hideLabels",
"type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "Roo.form.Layout"
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "emptyText",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf" : "Roo.form.Layout"
},
{
- "name" : "fck",
- "type" : "Object",
- "desc" : "BasePath",
- "memberOf" : ""
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "Roo.form.Layout"
},
{
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "Roo.form.Layout"
},
{
- "name" : "fieldLabel",
+ "name" : "legend",
"type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The text to display as the legend for the FieldSet (defaults to '')",
+ "memberOf" : ""
},
{
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
+ "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" : "grow",
- "type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
+ "name" : "style",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf" : "Roo.form.Layout"
+ }
+ ],
+ "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"
},
{
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
- "memberOf" : "Roo.form.TextArea"
+ "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"
},
{
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum height to allow when grow = true (defaults to 60)",
- "memberOf" : "Roo.form.TextArea"
+ "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"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "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"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "Roo.form.Layout"
},
{
- "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.form.TextField"
+ "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"
},
{
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
+ "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"
},
{
- "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.form.TextField"
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field"
+ "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"
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "preventScrollbars",
- "type" : "Boolean",
- "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
- "memberOf" : "Roo.form.TextArea"
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
+ "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"
},
{
- "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.form.TextField"
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "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"
},
{
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
},
{
- "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.form.Field"
+ "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"
},
{
- "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.form.TextField"
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component"
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
}
- ],
- "events" : [
+ ]
+ },
+ "Roo.form.Form" : {
+ "props" : [
{
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField"
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "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"
+ "name" : "buttonAlign",
+ "type" : "String",
+ "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
+ "memberOf" : ""
+ },
+ {
+ "name" : "errorMask",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.form.BasicForm",
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "errorReader",
+ "type" : "DataReader",
+ "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
+ "memberOf" : "Roo.form.BasicForm"
+ },
+ {
+ "name" : "fileUpload",
+ "type" : "Boolean",
+ "desc" : "Set to true if this form is a file upload.",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "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"
+ "name" : "formData",
+ "type" : "boolean|FormData",
+ "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.",
+ "memberOf" : ""
},
{
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "itemCls",
+ "type" : "String",
+ "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
+ "memberOf" : ""
},
{
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.",
+ "memberOf" : ""
},
{
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "The width of labels. This property cascades to child containers.",
+ "memberOf" : ""
},
{
- "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.form.Field"
+ "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" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "maskOffset",
+ "type" : "Number",
+ "desc" : "Default 100",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "method",
+ "type" : "String",
+ "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "editorinit",
- "type" : "function",
- "desc" : "Fired when the editor is initialized - you can add extra handlers here..",
- "sig" : "function (_self, the)\n{\n\n}",
+ "name" : "minButtonWidth",
+ "type" : "Number",
+ "desc" : "Minimum width of all buttons in pixels (defaults to 75)",
"memberOf" : ""
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "monitorPoll",
+ "type" : "Number",
+ "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
+ "memberOf" : ""
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "name" : "monitorValid",
+ "type" : "Boolean",
+ "desc" : "If true the form monitors its valid state <b>client-side</b> and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.",
+ "memberOf" : ""
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "progressUrl",
+ "type" : "String",
+ "desc" : "- Url to return progress data",
+ "memberOf" : ""
},
{
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "name" : "reader",
+ "type" : "DataReader",
+ "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent"
+ "name" : "trackResetOnLoad",
+ "type" : "Boolean",
+ "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "render",
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf" : "Roo.form.BasicForm"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "actioncomplete",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "resize",
+ "name" : "actionfailed",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "show",
+ "name" : "beforeaction",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "specialkey",
+ "name" : "clientvalidation",
"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.form.Field"
+ "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
+ "sig" : "function (_self, valid)\n{\n\n}",
+ "memberOf" : ""
},
{
- "name" : "valid",
+ "name" : "rendered",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "desc" : "Fires when the form is rendered",
+ "sig" : "function (form)\n{\n\n}",
+ "memberOf" : ""
}
],
"methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.",
+ "sig" : "(field1, field2)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "addButton",
+ "type" : "function",
+ "desc" : "Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.",
+ "sig" : "(config, handler, scope)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "addEvents",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "addForm",
+ "type" : "function",
+ "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
+ "sig" : "(form)",
+ "static" : false,
+ "memberOf" : "Roo.form.BasicForm"
+ },
{
"name" : "addListener",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "applyTo",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
- "name" : "autoSize",
+ "name" : "applyIfToFields",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.form.TextArea"
+ "memberOf" : "Roo.form.BasicForm"
+ },
+ {
+ "name" : "applyToFields",
+ "type" : "function",
+ "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "capture",
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "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"
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Clears all invalid messages in this form.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "fireEvent",
+ "name" : "column",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.",
+ "sig" : "(config, field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : ""
},
{
- "name" : "focus",
+ "name" : "container",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.",
+ "sig" : "(config, field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "getBox",
+ "name" : "doAction",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
"static" : false,
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "getEl",
+ "name" : "end",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Closes the current open container",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "getId",
+ "name" : "fieldset",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.",
+ "sig" : "(config, field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "getName",
+ "name" : "findField",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "getPosition",
+ "name" : "findbyId",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : ""
},
{
- "name" : "getRawValue",
+ "name" : "fireEvent",
"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}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "getSize",
+ "name" : "getFieldValues",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "getValue",
+ "name" : "getValues",
"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}",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "hasChanged",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "hasListener",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "hide",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "isDirty",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "desc" : "Returns true if client-side validation on the form is successful.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "isValid",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
+ "desc" : "Shortcut to do a load action.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "isVisible",
+ "name" : "loadRecord",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads an Roo.data.Record into this form.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "onPosition",
- "type" : "function",
- "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.BoxComponent"
- },
- {
- "name" : "onResize",
- "type" : "function",
- "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.BoxComponent"
- },
{
"name" : "purgeListeners",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Removes a field from the items collection (does NOT remove its markup).",
+ "sig" : "(field)",
+ "static" : false,
+ "memberOf" : "Roo.form.BasicForm"
+ },
{
"name" : "removeListener",
"type" : "function",
{
"name" : "render",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "desc" : "Render this form into the passed container. This should only be called once!",
"sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets this form.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "resetHasChanged",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
+ "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "setPagePosition",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
- {
- "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.form.Field"
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "setSize",
+ "name" : "setValues",
"type" : "function",
- "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)",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.form.BasicForm"
},
{
- "name" : "setValue",
+ "name" : "start",
"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" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.",
+ "sig" : "(container)",
"static" : false,
"memberOf" : ""
},
{
- "name" : "setVisible",
+ "name" : "startMonitoring",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "show",
+ "name" : "stopMonitoring",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "Stops monitoring of the valid state of this form",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : ""
},
{
- "name" : "syncSize",
+ "name" : "submit",
"type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Shortcut to do a submit action.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "un",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validateValue",
+ "name" : "updateRecord",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
+ "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.BasicForm"
}
]
},
- "Roo.form.Field" : {
+ "Roo.form.GridField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "addTitle",
+ "type" : "String",
+ "desc" : "Text to include for adding a title.",
+ "memberOf" : ""
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
"memberOf" : ""
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "disableClass",
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "height",
"type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "- used to restrict height of grid..",
+ "memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "listeners",
"name" : "msgFx",
"type" : "String",
"desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "msgTarget",
"type" : "String",
"desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"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" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "width",
"type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "- used to restrict width of grid..",
+ "memberOf" : ""
+ },
+ {
+ "name" : "xgrid",
+ "type" : "Object",
+ "desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
+ "memberOf" : ""
}
],
"events" : [
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"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" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "destroy",
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "hide",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "keyup",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "move",
"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" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "valid",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
}
],
"methods" : [
"desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
"sig" : "(el)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "capture",
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "destroy",
"desc" : "Returns the name attribute of the field if available",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "getPosition",
"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" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "getSize",
"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" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "hasChanged",
"desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "hasListener",
"desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "isValid",
"desc" : "Returns whether or not the field value is currently valid",
"sig" : "(preventMark)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "isVisible",
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "on",
"desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "resetHasChanged",
"desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "setDisabled",
"desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
"sig" : "(value)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "setSize",
{
"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)",
+ "desc" : "Sets the value of the item.",
+ "sig" : "(either)",
"static" : false,
"memberOf" : ""
},
"desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
}
]
},
- "Roo.form.FieldSet" : {
+ "Roo.form.Hidden" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
- "memberOf" : ""
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf" : "Roo.form.Layout"
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "disableClass",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideLabels",
+ "name" : "disableKeyFilter",
"type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "labelAlign",
+ "name" : "emptyText",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "labelSeparator",
+ "name" : "fieldClass",
"type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "legend",
+ "name" : "fieldLabel",
"type" : "String",
- "desc" : "The text to display as the legend for the FieldSet (defaults to '')",
- "memberOf" : ""
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "style",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf" : "Roo.form.Layout"
- }
- ],
- "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"
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field"
},
{
- "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"
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field"
},
{
- "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"
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField"
},
{
- "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"
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : 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"
},
{
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "Roo.form.Layout"
+ "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.form.TextField"
},
{
- "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"
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField"
},
{
- "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"
+ "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.form.TextField"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "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.form.TextField"
},
{
- "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"
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "msgTarget",
+ "type" : "String",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field"
},
{
- "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"
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "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.form.TextField"
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
},
{
- "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"
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field"
},
{
- "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"
+ "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.form.Field"
},
{
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "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.form.TextField"
},
{
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
}
- ]
- },
- "Roo.form.Form" : {
- "props" : [
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : "Roo.form.BasicForm"
- },
- {
- "name" : "buttonAlign",
- "type" : "String",
- "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
- "memberOf" : ""
- },
+ ],
+ "events" : [
{
- "name" : "errorReader",
- "type" : "DataReader",
- "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
- "memberOf" : "Roo.form.BasicForm"
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "fileUpload",
- "type" : "Boolean",
- "desc" : "Set to true if this form is a file upload.",
- "memberOf" : "Roo.form.BasicForm"
+ "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"
},
{
- "name" : "formData",
- "type" : "boolean|FormData",
- "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.",
- "memberOf" : ""
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "itemCls",
- "type" : "String",
- "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
- "memberOf" : ""
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.",
- "memberOf" : ""
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "The width of labels. This property cascades to child containers.",
- "memberOf" : ""
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "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" : "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.form.Field"
},
{
- "name" : "method",
- "type" : "String",
- "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
- "memberOf" : "Roo.form.BasicForm"
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "minButtonWidth",
- "type" : "Number",
- "desc" : "Minimum width of all buttons in pixels (defaults to 75)",
- "memberOf" : ""
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "monitorPoll",
- "type" : "Number",
- "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
- "memberOf" : ""
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "monitorValid",
- "type" : "Boolean",
- "desc" : "If true the form monitors its valid state <b>client-side</b> and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.",
- "memberOf" : ""
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "progressUrl",
- "type" : "String",
- "desc" : "- Url to return progress data",
- "memberOf" : ""
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "reader",
- "type" : "DataReader",
- "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
- "memberOf" : "Roo.form.BasicForm"
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "timeout",
- "type" : "Number",
- "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : "Roo.form.BasicForm"
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "trackResetOnLoad",
- "type" : "Boolean",
- "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
- "memberOf" : "Roo.form.BasicForm"
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : "Roo.form.BasicForm"
- }
- ],
- "events" : [
- {
- "name" : "actioncomplete",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when an action is completed.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "Roo.form.BasicForm"
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "actionfailed",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires when an action fails.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "Roo.form.BasicForm"
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "beforeaction",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "Roo.form.BasicForm"
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "clientvalidation",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
- "sig" : "function (_self, valid)\n{\n\n}",
- "memberOf" : ""
+ "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.form.Field"
},
{
- "name" : "rendered",
+ "name" : "valid",
"type" : "function",
- "desc" : "Fires when the form is rendered",
- "sig" : "function (form)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.",
- "sig" : "(field1, field2)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "addButton",
- "type" : "function",
- "desc" : "Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.",
- "sig" : "(config, handler, scope)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "addEvents",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "addForm",
- "type" : "function",
- "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
- "sig" : "(form)",
- "static" : false,
- "memberOf" : "Roo.form.BasicForm"
- },
{
"name" : "addListener",
"type" : "function",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "applyIfToFields",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "applyToFields",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "capture",
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Clears all invalid messages in this form.",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "column",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.",
- "sig" : "(config, field1, field2, etc)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "container",
+ "name" : "disable",
"type" : "function",
- "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.",
- "sig" : "(config, field1, field2, etc)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "doAction",
+ "name" : "enable",
"type" : "function",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
- "sig" : "(actionName, options)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "end",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Closes the current open container",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "fieldset",
+ "name" : "getId",
"type" : "function",
- "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.",
- "sig" : "(config, field1, field2, etc)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "findField",
+ "name" : "getName",
"type" : "function",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
- "sig" : "(id)",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "findbyId",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..",
- "sig" : "(id)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "fireEvent",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "getFieldValues",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "getValues",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
- "sig" : "(asString)",
+ "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.form.BasicForm"
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "hasChanged",
"type" : "function",
- "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "hasListener",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "isDirty",
+ "name" : "hide",
"type" : "function",
- "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "isValid",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Returns true if client-side validation on the form is successful.",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "load",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Shortcut to do a load action.",
- "sig" : "(options)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "loadRecord",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Loads an Roo.data.Record into this form.",
- "sig" : "(record)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.Component"
},
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark fields in this form invalid in bulk.",
- "sig" : "(errors)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "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.BoxComponent"
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "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.BoxComponent"
+ },
{
"name" : "purgeListeners",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Removes a field from the items collection (does NOT remove its markup).",
- "sig" : "(field)",
- "static" : false,
- "memberOf" : "Roo.form.BasicForm"
- },
{
"name" : "removeListener",
"type" : "function",
{
"name" : "render",
"type" : "function",
- "desc" : "Render this form into the passed container. This should only be called once!",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
"sig" : "(container)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets this form.",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "resetHasChanged",
"type" : "function",
- "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
+ "desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "setValues",
+ "name" : "selectText",
"type" : "function",
- "desc" : "Set values for fields in this form in bulk.",
- "sig" : "(values)",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "start",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.",
- "sig" : "(container)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "startMonitoring",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"",
- "sig" : "()\n{\n\n}",
+ "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"
},
{
- "name" : "stopMonitoring",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Stops monitoring of the valid state of this form",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
- "name" : "submit",
+ "name" : "syncSize",
"type" : "function",
- "desc" : "Shortcut to do a submit action.",
- "sig" : "(options)",
+ "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" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.BoxComponent"
},
{
"name" : "un",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "updateRecord",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
- "sig" : "(record)",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
}
]
},
- "Roo.form.GridField" : {
+ "Roo.form.HtmlEditor" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "addTitle",
- "type" : "String",
- "desc" : "Text to include for adding a title.",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "name" : "blacklist",
+ "type" : "Array",
+ "desc" : "of html tags - in addition to standard blacklist.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "clearUp",
+ "type" : "Boolean",
+ "desc" : "",
"memberOf" : ""
},
{
"desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "height",
"type" : "Number",
- "desc" : "- used to restrict height of grid..",
+ "desc" : "(in pixels)",
"memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "msgTarget",
"type" : "String",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "resizable",
+ "type" : "String",
+ "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "stylesheets",
+ "type" : "Array",
+ "desc" : "url of stylesheets. set to [] to disable stylesheets.",
+ "memberOf" : ""
+ },
{
"name" : "tabIndex",
"type" : "Number",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "name" : "toolbars",
+ "type" : "Array",
+ "desc" : "Array of toolbars. - defaults to just the Standard one",
+ "memberOf" : ""
},
{
"name" : "validationDelay",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "- used to restrict width of grid..",
+ "name" : "whitelist",
+ "type" : "Array",
+ "desc" : "of html tags - in addition to statndard whitelist",
"memberOf" : ""
},
{
- "name" : "xgrid",
- "type" : "Object",
- "desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "(in pixels)",
"memberOf" : ""
}
],
"events" : [
+ {
+ "name" : "activate",
+ "type" : "function",
+ "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "autosave",
+ "type" : "function",
+ "desc" : "Auto save the htmlEditor value as a file into Events",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforepush",
+ "type" : "function",
+ "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforerender",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforesync",
+ "type" : "function",
+ "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "blur",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : ""
},
{
"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.form.Field"
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "destroy",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "editmodechange",
+ "type" : "function",
+ "desc" : "Fires when the editor switches edit modes",
+ "sig" : "function (_self, sourceEdit)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "editorevent",
+ "type" : "function",
+ "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "enable",
"type" : "function",
"memberOf" : "Roo.Component"
},
{
- "name" : "focus",
+ "name" : "firstfocus",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
+ "desc" : "Fires when on first focus - needed by toolbars..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "hide",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "initialize",
+ "type" : "function",
+ "desc" : "Fires when the editor is fully initialized (including the iframe)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "invalid",
"type" : "function",
"sig" : "function (_self, x, y)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "push",
+ "type" : "function",
+ "desc" : "Fires when the iframe editor is updated with content from the textarea.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "savedpreview",
+ "type" : "function",
+ "desc" : "preview the saved version of htmlEditor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "show",
"type" : "function",
{
"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.form.Field"
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "stylesheetsclick",
+ "type" : "function",
+ "desc" : "Fires when press the Sytlesheets button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : ""
+ },
+ {
+ "name" : "sync",
+ "type" : "function",
+ "desc" : "Fires when the textarea is updated with content from the editor iframe.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : ""
},
{
"name" : "valid",
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
+ },
+ {
+ "name" : "createToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
+ "sig" : "(editor)",
+ "static" : false,
+ "memberOf" : ""
},
{
"name" : "destroy",
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "on",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the value of the item.",
- "sig" : "(either)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "setVisible",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "toggleSourceEdit",
+ "type" : "function",
+ "desc" : "Toggles the editor between standard and source edit mode.",
+ "sig" : "(sourceEdit)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "un",
"type" : "function",
}
]
},
- "Roo.form.Hidden" : {
+ "Roo.form.HtmlEditor.ToolbarContext" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
+ "name" : "disable",
+ "type" : "Object",
+ "desc" : "List of toolbar elements to disable",
+ "memberOf" : ""
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
- },
+ "name" : "styles",
+ "type" : "Object",
+ "desc" : "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.form.HtmlEditor.ToolbarStandard" : {
+ "props" : [
{
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field"
+ "name" : "btns",
+ "type" : "Array",
+ "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "memberOf" : ""
},
{
- "name" : "blankText",
+ "name" : "createLinkText",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "The default text for the create link prompt",
+ "memberOf" : ""
},
{
- "name" : "cls",
+ "name" : "defaultFont",
"type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "default font to use.",
+ "memberOf" : ""
},
{
- "name" : "disableClass",
+ "name" : "defaultLinkValue",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The default value for the create link prompt (defaults to http:/ /)",
+ "memberOf" : ""
},
{
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "name" : "disable",
+ "type" : "Object",
+ "desc" : "List of elements to disable..",
+ "memberOf" : ""
},
{
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
- },
+ "name" : "fontFamilies",
+ "type" : "Array",
+ "desc" : "An array of available font families",
+ "memberOf" : ""
+ }
+ ],
+ "events" : [],
+ "methods" : [
{
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
- },
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ }
+ ]
+ },
+ "Roo.form.Layout" : {
+ "props" : [
{
- "name" : "focusClass",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
+ "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" : "grow",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "memberOf" : ""
},
{
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : ""
},
{
- "name" : "msgFx",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field"
+ "name" : "hideLabels",
+ "type" : "Boolean",
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "name",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "qtip",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.TextField"
+ "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf" : ""
},
{
- "name" : "regexText",
+ "name" : "labelSeparator",
"type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : ""
},
{
- "name" : "validationDelay",
+ "name" : "labelWidth",
"type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.Field"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : ""
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "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" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "name" : "style",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf" : ""
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.Field"
- },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent"
- },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent"
- },
{
"name" : "show",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "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.form.Field"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
}
],
"methods" : [
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "applyTo",
- "type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "autoSize",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "capture",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent"
- },
{
"name" : "getEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "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.form.Field"
- },
- {
- "name" : "getSize",
- "type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "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.form.Field"
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "hasListener",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "onPosition",
- "type" : "function",
- "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.BoxComponent"
- },
- {
- "name" : "onResize",
- "type" : "function",
- "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.BoxComponent"
- },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "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.form.TextField"
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setPagePosition",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
- {
- "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.form.Field"
- },
- {
- "name" : "setSize",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
- {
- "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.form.Field"
- },
{
"name" : "setVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "syncSize",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
{
"name" : "un",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.TextField"
}
]
},
- "Roo.form.HtmlEditor" : {
+ "Roo.form.MonthField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "blacklist",
- "type" : "Array",
- "desc" : "of html tags - in addition to standard blacklist.",
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "altFormats",
+ "type" : "String",
+ "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
"memberOf" : ""
},
{
- "name" : "clearUp",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
"memberOf" : ""
},
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "disabledDates",
+ "type" : "Array",
+ "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
+ "memberOf" : ""
+ },
+ {
+ "name" : "disabledDatesText",
+ "type" : "String",
+ "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "disabledDays",
+ "type" : "Array",
+ "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "disabledDaysText",
+ "type" : "String",
+ "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "format",
+ "type" : "String",
+ "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
+ "memberOf" : ""
+ },
{
"name" : "height",
"type" : "Number",
- "desc" : "(in pixels)",
- "memberOf" : ""
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
+ "memberOf" : ""
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "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.form.TextField"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "maxTextf",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
+ "memberOf" : ""
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Date/String",
+ "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minValue",
+ "type" : "Date/String",
+ "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "msgFx",
+ "type" : "String",
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "msgTarget",
"type" : "String",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "resizable",
+ "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.form.TextField"
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "stylesheets",
- "type" : "Array",
- "desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : ""
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "tabIndex",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "toolbars",
- "type" : "Array",
- "desc" : "Array of toolbars. - defaults to just the Standard one",
+ "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' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "useIso",
+ "type" : "Boolean",
+ "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)",
"memberOf" : ""
},
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf" : "Roo.form.Field"
},
+ {
+ "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.form.TextField"
+ },
{
"name" : "value",
"type" : "Mixed",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "whitelist",
- "type" : "Array",
- "desc" : "of html tags - in addition to statndard whitelist",
- "memberOf" : ""
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "width",
"type" : "Number",
- "desc" : "(in pixels)",
- "memberOf" : ""
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
}
],
"events" : [
{
- "name" : "activate",
- "type" : "function",
- "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "autosave",
+ "name" : "autosize",
"type" : "function",
- "desc" : "Auto save the htmlEditor value as a file into Events",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "beforedestroy",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforepush",
- "type" : "function",
- "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforerender",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforesync",
- "type" : "function",
- "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "blur",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "change",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "destroy",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "editmodechange",
- "type" : "function",
- "desc" : "Fires when the editor switches edit modes",
- "sig" : "function (_self, sourceEdit)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "editorevent",
- "type" : "function",
- "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "enable",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "firstfocus",
- "type" : "function",
- "desc" : "Fires when on first focus - needed by toolbars..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "focus",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "hide",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "initialize",
- "type" : "function",
- "desc" : "Fires when the editor is fully initialized (including the iframe)",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "invalid",
"type" : "function",
"sig" : "function (_self, x, y)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
- {
- "name" : "push",
- "type" : "function",
- "desc" : "Fires when the iframe editor is updated with content from the textarea.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "render",
"type" : "function",
"memberOf" : "Roo.BoxComponent"
},
{
- "name" : "savedpreview",
+ "name" : "select",
"type" : "function",
- "desc" : "preview the saved version of htmlEditor",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (combo, date)\n{\n\n}",
"memberOf" : ""
},
{
{
"name" : "specialkey",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "stylesheetsclick",
- "type" : "function",
- "desc" : "Fires when press the Sytlesheets button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : ""
- },
- {
- "name" : "sync",
- "type" : "function",
- "desc" : "Fires when the textarea is updated with content from the editor iframe.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : ""
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "valid",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField"
+ },
{
"name" : "capture",
"type" : "function",
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
- },
- {
- "name" : "createToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
- "sig" : "(editor)",
- "static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "destroy",
{
"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}.",
+ "desc" : "Returns the current date value of the date field.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "hasChanged",
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "on",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "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.form.TriggerField"
+ },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "resetHasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "setDisabled",
"type" : "function",
{
"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)",
+ "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n</code></pre>",
+ "sig" : "(date)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : ""
},
{
"name" : "setVisible",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "name" : "toggleSourceEdit",
- "type" : "function",
- "desc" : "Toggles the editor between standard and source edit mode.",
- "sig" : "(sourceEdit)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "un",
"type" : "function",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
}
]
},
- "Roo.form.HtmlEditor.ToolbarContext" : {
+ "Roo.form.NumberField" : {
"props" : [
{
- "name" : "disable",
- "type" : "Object",
- "desc" : "List of toolbar elements to disable",
- "memberOf" : ""
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "styles",
- "type" : "Object",
- "desc" : "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }",
- "memberOf" : ""
- }
- ],
- "events" : [
- ],
- "methods" : [
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
- "name" : "updateToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
"memberOf" : ""
- }
- ]
- },
- "Roo.form.HtmlEditor.ToolbarStandard" : {
- "props" : [
+ },
{
- "name" : "btns",
- "type" : "Array",
- "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "allowNegative",
+ "type" : "Boolean",
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
"memberOf" : ""
},
{
- "name" : "createLinkText",
+ "name" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "blankText",
"type" : "String",
- "desc" : "The default text for the create link prompt",
- "memberOf" : ""
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "defaultFont",
+ "name" : "cls",
"type" : "String",
- "desc" : "default font to use.",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "decimalPrecision",
+ "type" : "Number",
+ "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
"memberOf" : ""
},
{
- "name" : "defaultLinkValue",
+ "name" : "decimalSeparator",
"type" : "String",
- "desc" : "The default value for the create link prompt (defaults to http:/ /)",
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
"memberOf" : ""
},
{
- "name" : "disable",
- "type" : "Object",
- "desc" : "List of elements to disable..",
- "memberOf" : ""
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "fontFamilies",
- "type" : "Array",
- "desc" : "An array of available font families",
- "memberOf" : ""
- }
- ],
- "events" : [
- ],
- "methods" : [
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
- "name" : "updateToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
"memberOf" : ""
- }
- ]
- },
- "Roo.form.Layout" : {
- "props" : [
+ },
{
- "name" : "actionMode",
+ "name" : "fieldLabel",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "allowDomMove",
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "grow",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "maskRe",
+ "type" : "String",
+ "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
"memberOf" : ""
},
{
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "name" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
"memberOf" : ""
},
{
- "name" : "disableClass",
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "minLengthText",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "hideLabels",
- "type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "name" : "minText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
"memberOf" : ""
},
{
- "name" : "hideMode",
+ "name" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "msgFx",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "labelAlign",
+ "name" : "msgTarget",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "nanText",
+ "type" : "String",
+ "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
"memberOf" : ""
},
{
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : ""
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "validationDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "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.form.TextField"
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : ""
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field"
},
{
- "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" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "style",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf" : ""
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.Field"
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
+ },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent"
+ },
{
"name" : "show",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field"
}
],
"methods" : [
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "addxtype",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "capture",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
{
"name" : "getEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "hasListener",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "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.BoxComponent"
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "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.BoxComponent"
+ },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "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.form.Field"
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
+ {
+ "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.form.Field"
+ },
{
"name" : "setVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "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" : "Roo.BoxComponent"
+ },
{
"name" : "un",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent"
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
}
]
},
- "Roo.form.MonthField" : {
+ "Roo.form.Radio" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "altFormats",
- "type" : "String",
- "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
- "memberOf" : ""
- },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
- "memberOf" : ""
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Checkbox"
},
{
- "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.form.TextField"
+ "desc" : "The text that appears beside the checkbox",
+ "memberOf" : "Roo.form.Checkbox"
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "cls",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "disabledDates",
- "type" : "Array",
- "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
- "memberOf" : ""
- },
- {
- "name" : "disabledDatesText",
- "type" : "String",
- "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
- "memberOf" : ""
- },
- {
- "name" : "disabledDays",
- "type" : "Array",
- "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "disabledDaysText",
- "type" : "String",
- "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf" : ""
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "fieldLabel",
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "format",
- "type" : "String",
- "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "height",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "inputValue",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value attribute",
+ "memberOf" : "Roo.form.Checkbox"
+ },
{
"name" : "invalidClass",
"type" : "String",
{
"name" : "invalidText",
"type" : "String",
- "desc" : "The error text to display when the date in the field is invalid (defaults to\n'{value} is not a valid date - it must be in the format {format}').",
- "memberOf" : ""
+ "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "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.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "maxTextf",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
- "memberOf" : ""
- },
- {
- "name" : "maxValue",
- "type" : "Date/String",
- "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
- "memberOf" : ""
- },
- {
- "name" : "minValue",
- "type" : "Date/String",
- "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : ""
- },
{
"name" : "msgFx",
"type" : "String",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
"memberOf" : "Roo.form.Field"
},
- {
- "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.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
"memberOf" : "Roo.form.Field"
},
- {
- "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' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
- "memberOf" : ""
- },
- {
- "name" : "useIso",
- "type" : "Boolean",
- "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)",
- "memberOf" : ""
- },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf" : "Roo.form.Field"
},
- {
- "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.form.TextField"
- },
{
"name" : "value",
"type" : "Mixed",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "vtype",
+ "name" : "valueOff",
"type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "The value that should go into the generated input element's value when unchecked.",
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "width",
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "check",
+ "type" : "function",
+ "desc" : "Fires when the checkbox is checked or unchecked.",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : "Roo.form.Checkbox"
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"memberOf" : "Roo.BoxComponent"
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (combo, date)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "show",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField"
- },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getGroupValue",
+ "type" : "function",
+ "desc" : "If this radio is part of a group, it will return the selected value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "getId",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the current date value of the date field.",
+ "desc" : "Returns the checked state of the checkbox.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "hasChanged",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "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.form.TriggerField"
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "resetHasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n</code></pre>",
- "sig" : "(date)",
+ "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" : ""
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "setVisible",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.form.Field"
- },
- {
- "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.form.TextField"
}
]
},
- "Roo.form.NumberField" : {
+ "Roo.form.Row" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "allowDecimals",
- "type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
- },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
+ "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "memberOf" : "Roo.form.Layout"
},
{
- "name" : "decimalSeparator",
- "type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : ""
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "disableClass",
"memberOf" : "Roo.Component"
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
+ "name" : "height",
+ "type" : "Number/String",
+ "desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
"memberOf" : ""
},
{
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "grow",
+ "name" : "hideLabels",
"type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "inputType",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf" : "Roo.form.Layout"
},
{
- "name" : "invalidClass",
+ "name" : "labelSeparator",
"type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "Roo.form.Layout"
},
{
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
- "memberOf" : ""
- },
- {
- "name" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
- "memberOf" : ""
- },
- {
- "name" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : ""
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "nanText",
- "type" : "String",
- "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
- "memberOf" : ""
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.Field"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "style",
+ "type" : "String/Object/Function",
+ "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "type" : "Number/String",
+ "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf" : ""
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.Field"
- },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent"
- },
{
"name" : "render",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent"
- },
{
"name" : "show",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "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.form.Field"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
}
],
"methods" : [
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "applyTo",
- "type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "autoSize",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Layout"
},
{
"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"
- },
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "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"
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent"
+ "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"
},
{
- "name" : "getEl",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component"
},
{
- "name" : "getId",
+ "name" : "disable",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component"
},
{
- "name" : "getName",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getRawValue",
+ "name" : "fireEvent",
"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}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.util.Observable"
},
{
- "name" : "getSize",
+ "name" : "focus",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "getValue",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.Component"
},
{
- "name" : "hasChanged",
+ "name" : "getId",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.Component"
},
{
"name" : "hasListener",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "onPosition",
- "type" : "function",
- "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.BoxComponent"
- },
- {
- "name" : "onResize",
- "type" : "function",
- "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.BoxComponent"
- },
{
"name" : "purgeListeners",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "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.form.TextField"
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setPagePosition",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
- {
- "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.form.Field"
- },
- {
- "name" : "setSize",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
- {
- "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.form.Field"
- },
{
"name" : "setVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "syncSize",
- "type" : "function",
- "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" : "Roo.BoxComponent"
- },
{
"name" : "un",
"type" : "function",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.TextField"
}
]
},
- "Roo.form.Radio" : {
+ "Roo.form.Select" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allQuery",
+ "type" : "String",
+ "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : ""
+ },
{
"name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Checkbox"
+ "type" : "Boolean/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf" : ""
},
{
- "name" : "boxLabel",
+ "name" : "blankText",
"type" : "String",
- "desc" : "The text that appears beside the checkbox",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField"
},
{
- "name" : "checked",
+ "name" : "blockFocus",
"type" : "Boolean",
- "desc" : "True if the the checkbox should render already checked (defaults to false)",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : ""
},
{
"name" : "cls",
"desc" : "A CSS class to apply to the field's underlying element.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "defaultValue",
+ "type" : "String",
+ "desc" : "The value displayed after loading the store.",
+ "memberOf" : ""
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "fieldLabel",
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : ""
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : ""
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : ""
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : ""
},
{
"name" : "height",
"desc" : "height (optional) size of component",
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : ""
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.form.TriggerField"
},
{
"name" : "inputType",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "inputValue",
- "type" : "String",
- "desc" : "The value that should go into the generated input element's value attribute",
- "memberOf" : "Roo.form.Checkbox"
- },
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : ""
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "loadingText",
+ "type" : "String",
+ "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "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.form.TextField"
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : ""
+ },
{
"name" : "msgFx",
"type" : "String",
"desc" : "The field's HTML name attribute.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "pageSize",
+ "type" : "Number",
+ "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf" : ""
+ },
{
"name" : "qtip",
"type" : "String",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "readOnly",
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : ""
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : ""
+ },
+ {
+ "name" : "transform",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf" : ""
+ },
+ {
+ "name" : "triggerAction",
+ "type" : "String",
+ "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf" : ""
+ },
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
+ "memberOf" : ""
+ },
+ {
+ "name" : "typeAhead",
"type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf" : ""
},
{
- "name" : "tabIndex",
+ "name" : "typeAheadDelay",
"type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : ""
},
{
"name" : "validateOnBlur",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf" : "Roo.form.Field"
},
+ {
+ "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.form.TextField"
+ },
{
"name" : "value",
"type" : "Mixed",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "valueOff",
+ "name" : "valueField",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf" : ""
+ },
+ {
+ "name" : "valueNotFoundText",
+ "type" : "String",
+ "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "width",
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the checkbox is checked or unchecked.",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : "Roo.form.Checkbox"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField"
+ },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "fireEvent",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getGroupValue",
- "type" : "function",
- "desc" : "If this radio is part of a group, it will return the selected value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "getId",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the checked state of the checkbox.",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Checkbox"
+ "memberOf" : ""
},
{
"name" : "hasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "isValid",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "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.form.TriggerField"
+ },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "resetHasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
- "sig" : "(value, suppressEvent)",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.form.Checkbox"
+ "memberOf" : ""
},
{
"name" : "setVisible",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "setWidth",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "show",
"type" : "function",
"desc" : "Sets the current box measurements of the component's underlying element.",
"sig" : "(box)",
"static" : false,
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- }
- ]
- },
- "Roo.form.Row" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "height",
- "type" : "Number/String",
- "desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
- },
- {
- "name" : "hideLabels",
- "type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "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" : "style",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "width",
- "type" : "Number/String",
- "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
- }
- ],
- "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"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component"
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "Roo.form.Layout"
- },
- {
- "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"
- },
- {
- "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"
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "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"
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable"
- },
- {
- "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"
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.BoxComponent"
},
{
- "name" : "show",
+ "name" : "validate",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.form.Field"
},
{
- "name" : "un",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.form.TextField"
}
]
},
- "Roo.form.Select" : {
+ "Roo.form.Signature" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : ""
- },
{
"name" : "allowBlank",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "False to validate that the value length > 0 (defaults to false)",
+ "memberOf" : ""
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : ""
- },
{
"name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : ""
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : ""
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "cls",
"desc" : "A CSS class to apply to the field's underlying element.",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "defaultValue",
- "type" : "String",
- "desc" : "The value displayed after loading the store.",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : ""
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : ""
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "fieldClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : ""
- },
{
"name" : "height",
"type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "desc" : "The signature panel height (defaults to 100)",
"memberOf" : ""
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : ""
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : ""
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "name" : "labels",
+ "type" : "Object",
+ "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
"memberOf" : ""
},
{
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : ""
- },
- {
- "name" : "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.form.TextField"
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : ""
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "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.form.TextField"
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : ""
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : ""
- },
{
"name" : "msgFx",
"type" : "String",
"desc" : "The field's HTML name attribute.",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : ""
- },
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : ""
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : ""
- },
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
"memberOf" : "Roo.form.Field"
},
- {
- "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.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : ""
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : ""
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
- },
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : ""
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : ""
- },
- {
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : ""
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : ""
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf" : ""
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : ""
- },
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf" : "Roo.form.Field"
},
- {
- "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.form.TextField"
- },
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : ""
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : ""
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "width",
"type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "The signature panel width (defaults to 300)",
+ "memberOf" : ""
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "confirm",
+ "type" : "function",
+ "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "resize",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField"
- },
{
"name" : "capture",
"type" : "function",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "collapse",
+ "name" : "createToolbar",
"type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
+ "sig" : "(editor)",
"static" : false,
"memberOf" : ""
},
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "enable",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "fireEvent",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
+ {
+ "name" : "getConfirmed",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "getEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getHeight",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "getId",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "getImageDataURI",
+ "type" : "function",
+ "desc" : "when user is clicked confirm then show this image.....",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "getName",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field"
+ },
+ {
+ "name" : "getWidth",
+ "type" : "function",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "isValid",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "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.form.TriggerField"
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "resetHasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField"
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : ""
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
"sig" : "(value)",
"static" : false,
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "setVisible",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "setWidth",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "show",
"type" : "function",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.form.Field"
- },
- {
- "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.form.TextField"
}
]
},
- "Roo.form.Signature" : {
+ "Roo.form.TextArea" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to false)",
- "memberOf" : ""
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field"
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
+ "memberOf" : ""
+ },
+ {
+ "name" : "blankText",
+ "type" : "String",
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "cls",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "fieldClass",
"type" : "String",
"memberOf" : "Roo.form.Field"
},
{
- "name" : "height",
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "growMax",
"type" : "Number",
- "desc" : "The signature panel height (defaults to 100)",
+ "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
"memberOf" : ""
},
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum height to allow when grow = true (defaults to 60)",
+ "memberOf" : ""
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
+ },
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "labels",
- "type" : "Object",
- "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
- "memberOf" : ""
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "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.form.TextField"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "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.form.TextField"
+ },
{
"name" : "msgFx",
"type" : "String",
"desc" : "The field's HTML name attribute.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "preventScrollbars",
+ "type" : "Boolean",
+ "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
+ "memberOf" : ""
+ },
{
"name" : "qtip",
"type" : "String",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "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.form.TextField"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf" : "Roo.form.Field"
},
+ {
+ "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.form.TextField"
+ },
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "width",
"type" : "Number",
- "desc" : "The signature panel width (defaults to 300)",
- "memberOf" : ""
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent"
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "confirm",
- "type" : "function",
- "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "resize",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "capture",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "createToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
- "sig" : "(editor)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "name" : "getConfirmed",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "getEl",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getHeight",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "getId",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getImageDataURI",
- "type" : "function",
- "desc" : "when user is clicked confirm then show this image.....",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "getName",
"type" : "function",
"static" : false,
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "getWidth",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "hasChanged",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "resetHasChanged",
"static" : false,
"memberOf" : "Roo.form.Field"
},
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "setDisabled",
"type" : "function",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.form.Field"
+ },
+ {
+ "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.form.TextField"
}
]
},
- "Roo.form.TextArea" : {
+ "Roo.form.TextField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : ""
+ },
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
- "memberOf" : ""
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "Roo.form.Field"
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "cls",
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "disabled",
"name" : "emptyText",
"type" : "String",
"desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "fieldClass",
"name" : "grow",
"type" : "Boolean",
"desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "growMax",
"type" : "Number",
- "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
"memberOf" : ""
},
{
"name" : "growMin",
"type" : "Number",
- "desc" : "The minimum height to allow when grow = true (defaults to 60)",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
"memberOf" : ""
},
{
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"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.form.TextField"
+ "memberOf" : ""
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "msgFx",
"desc" : "The field's HTML name attribute.",
"memberOf" : "Roo.form.Field"
},
- {
- "name" : "preventScrollbars",
- "type" : "Boolean",
- "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
- "memberOf" : ""
- },
{
"name" : "qtip",
"type" : "String",
"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.form.TextField"
+ "memberOf" : ""
},
{
"name" : "regexText",
"type" : "String",
"desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "tabIndex",
"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.form.TextField"
+ "memberOf" : ""
},
{
"name" : "value",
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "width",
"type" : "function",
"desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
"sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "beforedestroy",
{
"name" : "autoSize",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
"desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "resetHasChanged",
"desc" : "Selects text in this field",
"sig" : "(start, end)",
"static" : false,
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : ""
},
{
"name" : "setDisabled",
"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.form.TextField"
+ "memberOf" : ""
}
]
},
- "Roo.form.TextField" : {
+ "Roo.form.TextItem" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : ""
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : ""
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : ""
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : ""
- },
{
"name" : "height",
"type" : "Number",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "invalidText",
+ "name" : "html",
"type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "the content for this item",
+ "memberOf" : ""
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : ""
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : ""
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : ""
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : ""
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : ""
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : ""
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "vtype",
+ "name" : "tag",
"type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "desc" : "the tag for this item (default div)",
"memberOf" : ""
},
{
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : ""
- },
{
"name" : "beforedestroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
- {
- "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.form.Field"
- },
{
"name" : "destroy",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "hide",
"type" : "function",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "move",
"type" : "function",
"desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component"
- },
- {
- "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.form.Field"
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field"
}
],
"methods" : [
"static" : false,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "applyTo",
- "type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "capture",
"type" : "function",
"static" : true,
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "destroy",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "getPosition",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "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.form.Field"
- },
{
"name" : "getSize",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "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.form.Field"
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "hasListener",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "isVisible",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
{
"name" : "on",
"type" : "function",
"static" : false,
"memberOf" : "Roo.Component"
},
- {
- "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" : ""
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : ""
- },
{
"name" : "setDisabled",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "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.form.Field"
- },
{
"name" : "setSize",
"type" : "function",
"static" : false,
"memberOf" : "Roo.BoxComponent"
},
- {
- "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.form.Field"
- },
{
"name" : "setVisible",
"type" : "function",
"sig" : "(box)",
"static" : false,
"memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field"
- },
- {
- "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" : ""
}
]
},
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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"
},
{
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField"
+ },
{
"name" : "autoCreate",
"type" : "String/Object",
{
"name" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideTrigger",
]
},
"Roo.form.VTypes" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "alpha'",
]
},
"Roo.grid" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.grid.AbstractGridView" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.grid.AbstractSelectionModel" : {
"props" : [
"memberOf" : "Roo.util.Observable"
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "addEvents",
}
],
"methods" : [
+ {
+ "name" : "addColumns",
+ "type" : "function",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid"
+ },
{
"name" : "addEvents",
"type" : "function",
}
],
"methods" : [
+ {
+ "name" : "addColumns",
+ "type" : "function",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
+ "static" : false,
+ "memberOf" : ""
+ },
{
"name" : "addEvents",
"type" : "function",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "ignoreNoChange",
"memberOf" : "Roo.util.Observable"
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "addEvents",
}
],
"methods" : [
+ {
+ "name" : "addColumns",
+ "type" : "function",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid"
+ },
{
"name" : "addEvents",
"type" : "function",
]
},
"Roo.lib" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.lib.Ajax" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "request",
]
},
"Roo.lib.Dom" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.menu" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.menu.Adapter" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
]
},
"Roo.menu.MenuMgr" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "get",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
]
},
"Roo.state" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.state.CookieProvider" : {
"props" : [
]
},
"Roo.state.Manager" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "clear",
]
},
"Roo.state.Provider" : {
- "props" : [
- ],
+ "props" : [],
"events" : [
{
"name" : "statechange",
]
},
"Roo.tree" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.tree.AsyncTreeNode" : {
"props" : [
"memberOf" : ""
}
],
- "methods" : [
- ]
+ "methods" : []
},
"Roo.tree.DefaultSelectionModel" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "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" : "hideMode",
"type" : "String",
- "desc" : [
- "(display",
- "visibility)"
- ],
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component",
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "ignoreNoChange",
]
},
"Roo.tree.TreeFilter" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "clear",
]
},
"Roo.tree.TreeNodeUI" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.tree.TreePanel" : {
"props" : [
"sig" : "function (tree, parent, node, index)\n{\n\n}",
"memberOf" : "Roo.data.Tree"
},
+ {
+ "name" : "appendnode",
+ "type" : "function",
+ "desc" : "Fires when append node to the tree",
+ "sig" : "function (_self, node, index)\n{\n\n}",
+ "memberOf" : ""
+ },
{
"name" : "beforeappend",
"type" : "function",
"memberOf" : ""
}
],
- "events" : [
- ],
- "methods" : [
- ]
+ "events" : [],
+ "methods" : []
},
"Roo.util" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.util.CSS" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "createStyleSheet",
]
},
"Roo.util.DelayedTask" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.util.Format" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "capitalize",
]
},
"Roo.util.JSON" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"Roo.util.MixedCollection" : {
"props" : [
"memberOf" : ""
}
],
- "events" : [
- ],
+ "events" : [],
"methods" : [
{
"name" : "addEvents",
]
},
"Roo.util.TextMetrics" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "createInstance",
]
},
"Roo.util.TextMetrics.Instance" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
},
"String" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "escape",
]
},
"_global_" : {
- "props" : [
- ],
- "events" : [
- ],
+ "props" : [],
+ "events" : [],
"methods" : [
{
"name" : "InlineLexer",
{
"name" : "Parser",
"type" : "function",
- "desc" : "Parsing & Compiling",
+ "desc" : "eval:var:Parser",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
{
"name" : "Renderer",
"type" : "function",
- "desc" : "Renderer",
+ "desc" : "eval:var:Renderer",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
{
"name" : "marked",
"type" : "function",
- "desc" : "Marked",
+ "desc" : "eval:var:marked",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "merge",
+ "type" : "function",
+ "desc" : "eval:var:merge",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : ""
+ },
+ {
+ "name" : "noop",
+ "type" : "function",
+ "desc" : "eval:var:noop",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : ""
]
},
"this" : {
- "props" : [
- ],
- "events" : [
- ],
- "methods" : [
- ]
+ "props" : [],
+ "events" : [],
+ "methods" : []
}
}
\ No newline at end of file
projects / roojs1 / blobdiff