],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Date" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Function" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Number" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Ajax" : {
"props" : [
"name" : "autoAbort",
"type" : "Boolean",
"desc" : "(Optional) Whether a new request should abort any pending requests. (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "defaultHeaders",
"type" : "Object",
"desc" : "An object containing request headers which are added to each request made by this object. (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "disableCaching",
"type" : "Boolean",
"desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "extraParams",
"type" : "Object",
"desc" : "An object containing properties which are used as extra parameters to each request made by this object. (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "listeners",
"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" : ""
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "timeout",
"type" : "Number",
"desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : ""
+ "memberOf" : "Roo.Ajax"
},
{
"name" : "url",
"type" : "String",
"desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.Ajax"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.BasicDialog" : {
"props" : [
"name" : "animateTarget",
"type" : "String/Element",
"desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "autoCreate",
"type" : "Boolean/DomHelper",
"desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "autoTabs",
"type" : "Boolean",
"desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "buttonAlign",
"type" : "String",
"desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "buttons",
"type" : "Array",
"desc" : "Array of buttons",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "False to remove the built-in top-right corner close button (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "collapsible",
"type" : "Boolean",
"desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "constraintoviewport",
"type" : "Boolean",
"desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "draggable",
"type" : "Boolean",
"desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "fixedcenter",
"type" : "Boolean",
"desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "height",
"type" : "Number",
"desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "listeners",
"name" : "minButtonWidth",
"type" : "Number",
"desc" : "Minimum width of all dialog buttons (defaults to 75)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "minHeight",
"type" : "Number",
"desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "modal",
"type" : "Boolean",
"desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "proxyDrag",
"type" : "Boolean",
"desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "resizable",
"type" : "Boolean",
"desc" : "False to disable manual dialog resizing (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "resizeHandles",
"type" : "String",
"desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "shadow",
"type" : "Boolean/String",
"desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "shadowOffset",
"type" : "Number",
"desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "shim",
"type" : "Boolean",
"desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "syncHeightBeforeShow",
"type" : "Boolean",
"desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "tabTag",
"type" : "String",
"desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "title",
"type" : "String",
"desc" : "Default text to display in the title bar (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "width",
"type" : "Number",
"desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "x",
"type" : "Number",
"desc" : "The default left page coordinate of the dialog (defaults to center screen)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
},
{
"name" : "y",
"type" : "Number",
"desc" : "The default top page coordinate of the dialog (defaults to center screen)",
- "memberOf" : ""
+ "memberOf" : "Roo.BasicDialog"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.BasicDialog" : [
+ "Roo.LayoutDialog"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.BasicLayoutRegion" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.LayoutRegion" : [
+ "Roo.SplitLayoutRegion",
+ "Roo.bootstrap.layout.Split"
+ ],
+ "Roo.BasicLayoutRegion" : [
+ "Roo.LayoutRegion"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.BorderLayout" : {
"props" : [
"name" : "center",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.BorderLayout"
},
{
"name" : "east",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.BorderLayout"
},
{
"name" : "listeners",
"name" : "north",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.BorderLayout"
},
{
"name" : "south",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.BorderLayout"
},
{
"name" : "west",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.BorderLayout"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.BorderLayout" : [
+ "Roo.ReaderLayout"
+ ]
+ },
+ "tree_children" : [
+ "Roo.ContentPanel",
+ "Roo.GridPanel",
+ "Roo.NestedLayoutPanel",
+ "Roo.TreePanel"
+ ],
+ "tree_parent" : []
},
"Roo.BoxComponent" : {
"props" : [
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : ""
+ "memberOf" : "Roo.BoxComponent"
},
{
"name" : "hideMode",
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : ""
+ "memberOf" : "Roo.BoxComponent"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.form.Field" : [
+ "Roo.form.Checkbox",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.GridField",
+ "Roo.form.HtmlEditor",
+ "Roo.form.Signature",
+ "Roo.form.TextField"
+ ],
+ "Roo.form.TextArea" : [
+ "Roo.form.FCKeditor"
+ ],
+ "Roo.BoxComponent" : [
+ "Roo.form.ComboBoxArray.Item",
+ "Roo.form.Field",
+ "Roo.form.TextItem"
+ ],
+ "Roo.form.Checkbox" : [
+ "Roo.form.Radio"
+ ],
+ "Roo.form.TextField" : [
+ "Roo.form.ComboBoxArray",
+ "Roo.form.Hidden",
+ "Roo.form.NumberField",
+ "Roo.form.TextArea",
+ "Roo.form.TriggerField"
+ ],
+ "Roo.form.TriggerField" : [
+ "Roo.form.ComboBox",
+ "Roo.form.DateField",
+ "Roo.form.MonthField",
+ "Roo.form.Select"
+ ],
+ "Roo.form.ComboBox" : [
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Button" : {
"props" : [
"name" : "clickEvent",
"type" : "String",
"desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to start disabled (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "enableToggle",
"type" : "Boolean",
"desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "handleMouseEvents",
"type" : "Boolean",
"desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function called when the button is clicked (can be used instead of click event)",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start hidden (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "icon",
"type" : "String",
"desc" : "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:\"x-btn-text-icon\")",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "iconCls",
"type" : "String",
"desc" : "A css class which sets a background image to be used as the icon for this button (defaults to undefined).",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "listeners",
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "menuAlign",
"type" : "String",
"desc" : "The position to align the menu to (see {@link Roo.Element#alignTo} for more details, defaults to 'tl-bl?').",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "renderTo",
"type" : "String/HTMLElement/Element",
"desc" : "The element to append the button to",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "repeat",
"type" : "Boolean/Object",
"desc" : "True to repeat fire the click event while the mouse is down. This can also be\n an {@link Roo.util.ClickRepeater} config object (defaults to false).",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "scope",
"type" : "Object",
"desc" : "The scope of the handler",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The DOM tabIndex for this button (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "template",
"type" : "Roo.Template",
"desc" : "(Optional)\nAn {@link Roo.Template} with which to create the Button's main element. This Template must\ncontain numeric substitution parameter 0 if it is to display the tRoo property. Changing the template could\nrequire code modifications if required elements (e.g. a button) aren't present.",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "text",
"type" : "String",
"desc" : "The button text",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "toggleGroup",
"type" : "String",
"desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "tooltip",
"type" : "String/Object",
"desc" : "The tooltip for the button - can be a string or QuickTips config object",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "tooltipType",
"type" : "String",
"desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
},
{
"name" : "type",
"type" : "String",
"desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : ""
+ "memberOf" : "Roo.Button"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.Button" : [
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button"
+ ],
+ "Roo.SplitButton" : [
+ "Roo.Toolbar.SplitButton"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.CalendarPanel" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.ColorPalette" : {
"props" : [
"name" : "allowReselect",
"type" : "Boolean",
"desc" : "If set to true then reselecting a color that is already selected fires the selection event",
- "memberOf" : ""
+ "memberOf" : "Roo.ColorPalette"
},
{
"name" : "disableClass",
"name" : "itemCls",
"type" : "String",
"desc" : "The CSS class to apply to the containing element (defaults to \"x-color-palette\")",
- "memberOf" : ""
+ "memberOf" : "Roo.ColorPalette"
},
{
"name" : "listeners",
"name" : "value",
"type" : "String",
"desc" : "The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that\nthe hex codes are case-sensitive.",
- "memberOf" : ""
+ "memberOf" : "Roo.ColorPalette"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Component" : {
"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" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "Roo.Component"
},
{
"name" : "listeners",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.nav.Bar" : [
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "Roo.form.Field" : [
+ "Roo.form.Checkbox",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.GridField",
+ "Roo.form.HtmlEditor",
+ "Roo.form.Signature",
+ "Roo.form.TextField"
+ ],
+ "Roo.bootstrap.nav.Simplebar" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.nav.Headerbar"
+ ],
+ "Roo.bootstrap.Button" : [
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ],
+ "Roo.bootstrap.Column" : [
+ "Roo.bootstrap.TabGroup"
+ ],
+ "Roo.bootstrap.form.TriggerField" : [
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.PhoneInput"
+ ],
+ "Roo.bootstrap.form.TextArea" : [
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown"
+ ],
+ "Roo.form.TextArea" : [
+ "Roo.form.FCKeditor"
+ ],
+ "Roo.Component" : [
+ "Roo.BoxComponent",
+ "Roo.CalendarPanel",
+ "Roo.ColorPalette",
+ "Roo.DatePicker",
+ "Roo.Editor",
+ "Roo.HtmlEditorCore",
+ "Roo.bootstrap.Component",
+ "Roo.form.Layout",
+ "Roo.menu.BaseItem"
+ ],
+ "Roo.bootstrap.layout.Manager" : [
+ "Roo.bootstrap.layout.Border"
+ ],
+ "Roo.BoxComponent" : [
+ "Roo.form.ComboBoxArray.Item",
+ "Roo.form.Field",
+ "Roo.form.TextItem"
+ ],
+ "Roo.bootstrap.Element" : [
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.DropTarget"
+ ],
+ "Roo.form.Checkbox" : [
+ "Roo.form.Radio"
+ ],
+ "Roo.Editor" : [
+ "Roo.grid.GridEditor",
+ "Roo.tree.TreeEditor"
+ ],
+ "Roo.menu.BaseItem" : [
+ "Roo.menu.Adapter",
+ "Roo.menu.Item",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem"
+ ],
+ "Roo.bootstrap.nav.Item" : [
+ "Roo.bootstrap.nav.SidebarItem"
+ ],
+ "Roo.form.TextField" : [
+ "Roo.form.ComboBoxArray",
+ "Roo.form.Hidden",
+ "Roo.form.NumberField",
+ "Roo.form.TextArea",
+ "Roo.form.TriggerField"
+ ],
+ "Roo.form.Layout" : [
+ "Roo.form.Column",
+ "Roo.form.FieldSet",
+ "Roo.form.Row"
+ ],
+ "Roo.menu.Item" : [
+ "Roo.menu.CheckItem"
+ ],
+ "Roo.menu.Adapter" : [
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem"
+ ],
+ "Roo.bootstrap.Component" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Body",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Modal",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.Popover",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.TableBody",
+ "Roo.bootstrap.TableCell",
+ "Roo.bootstrap.TableRow",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Item",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.layout.Manager",
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Menu",
+ "Roo.bootstrap.menu.Separator",
+ "Roo.bootstrap.nav.Bar",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem"
+ ],
+ "Roo.bootstrap.form.ComboBox" : [
+ "Roo.bootstrap.form.MoneyField"
+ ],
+ "Roo.form.TriggerField" : [
+ "Roo.form.ComboBox",
+ "Roo.form.DateField",
+ "Roo.form.MonthField",
+ "Roo.form.Select"
+ ],
+ "Roo.form.ComboBox" : [
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested"
+ ],
+ "Roo.bootstrap.form.Input" : [
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.ComponentMgr" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.CompositeElement" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.CompositeElement" : [
+ "Roo.CompositeElementLite"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.CompositeElementLite" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.ContentPanel" : {
"props" : [
"name" : "adjustments",
"type" : "Array",
"desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "autoCreate",
"type" : "Boolean|Object",
"desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "fitContainer",
"type" : "Boolean",
"desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "fitToFrame",
"type" : "Boolean",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "listeners",
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "popup menu",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "params",
"type" : "String|Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "region",
"type" : "String",
"desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "resizeEl",
"type" : "String|HTMLElement|Element",
"desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "style",
"type" : "String",
"desc" : "Extra style to add to the content panel",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "Roo.ContentPanel"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : true,
+ "childClasses" : {
+ "Roo.ContentPanel" : [
+ "Roo.GridPanel",
+ "Roo.NestedLayoutPanel",
+ "Roo.TreePanel"
+ ]
+ },
+ "tree_children" : [
+ "Roo.form.Form",
+ "Roo.JsonView",
+ "Roo.View",
+ "Roo.JsonView"
+ ],
+ "tree_parent" : []
},
"Roo.DDView" : {
"props" : [
"name" : "allowCopy",
"type" : "Boolean",
"desc" : "Causes ctrl/drag operations to copy nodes rather than move.",
- "memberOf" : ""
+ "memberOf" : "Roo.DDView"
},
{
"name" : "copy",
"type" : "Boolean",
"desc" : "Causes drag operations to copy nodes rather than move.",
- "memberOf" : ""
+ "memberOf" : "Roo.DDView"
},
{
"name" : "dragGroup",
"type" : "String/Array",
"desc" : "The ddgroup name(s) for the View's DragZone.",
- "memberOf" : ""
+ "memberOf" : "Roo.DDView"
},
{
"name" : "dropGroup",
"type" : "String/Array",
"desc" : "The ddgroup name(s) for the View's DropZone.",
- "memberOf" : ""
+ "memberOf" : "Roo.DDView"
}
],
"events" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.DatePicker" : {
"props" : [
"name" : "cancelText",
"type" : "String",
"desc" : "The text to display on the cancel button",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "constrainToViewport",
"type" : "Boolean",
"desc" : "True to constrain the date picker to the viewport (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "dayNames",
"type" : "Array",
"desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "disableClass",
"name" : "disabledDatesRE",
"type" : "RegExp",
"desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "disabledDatesText",
"type" : "String",
"desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"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" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "disabledDaysText",
"type" : "String",
"desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"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" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "hideMode",
"name" : "maxDate",
"type" : "Date",
"desc" : "Maximum allowable date (JavaScript date object, defaults to null)",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "maxText",
"type" : "String",
"desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "minDate",
"type" : "Date",
"desc" : "Minimum allowable date (JavaScript date object, defaults to null)",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "minText",
"type" : "String",
"desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "monthNames",
"type" : "Array",
"desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "monthYearText",
"type" : "String",
"desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "nextText",
"type" : "String",
"desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "okText",
"type" : "String",
"desc" : "The text to display on the ok button",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "prevText",
"type" : "String",
"desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "showClear",
"type" : "Bool",
"desc" : "Show a clear button (usefull for date form elements that can be blank.)",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "startDay",
"type" : "Number",
"desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "todayText",
"type" : "String",
"desc" : "The text to display on the button that selects the current date (defaults to \"Today\")",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
},
{
"name" : "todayTip",
"type" : "String",
"desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")",
- "memberOf" : ""
+ "memberOf" : "Roo.DatePicker"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.DialogManager" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Document" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.DomHelper" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.DomQuery" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.DomTemplate" : {
"props" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Editor" : {
"props" : [
"name" : "alignment",
"type" : "String",
"desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "allowDomMove",
"name" : "autosize",
"type" : "Boolean/String",
"desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "cancelOnEsc",
"type" : "Boolean",
"desc" : "True to cancel the edit when the escape key is pressed (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "completeOnEnter",
"type" : "Boolean",
"desc" : "True to complete the edit when the enter key is pressed (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "constrain",
"type" : "Boolean",
"desc" : "True to constrain the editor to the viewport",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "disableClass",
"name" : "hideEl",
"type" : "Boolean",
"desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "hideMode",
"name" : "ignoreNoChange",
"type" : "Boolean",
"desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "listeners",
"name" : "revertInvalid",
"type" : "Boolean",
"desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "shadow",
"type" : "Boolean/String",
"desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "updateEl",
"type" : "Boolean",
"desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "The data value of the underlying field (defaults to \"\")",
- "memberOf" : ""
+ "memberOf" : "Roo.Editor"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.Editor" : [
+ "Roo.grid.GridEditor",
+ "Roo.tree.TreeEditor"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Element" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.Element" : [
+ "Roo.Layer"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.EventManager" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.EventObject" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Fx" : {
"props" : [
"name" : "afterCls",
"type" : "String",
"desc" : "A css class to apply after the effect",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "afterStyle",
"type" : "String/Object/Function",
"desc" : "A style specification string, e.g. \"width:100px\", or an object in the form {width:\"100px\"}, or\na function which returns such a specification that will be applied to the Element after the effect finishes",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "block",
"type" : "Boolean",
"desc" : "Whether the effect should block other effects from queueing while it runs",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "callback",
"type" : "Function",
"desc" : "A function called when the effect is finished",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "concurrent",
"type" : "Boolean",
"desc" : "Whether to allow subsequently-queued effects to run at the same time as the current effect, or to ensure that they run in sequence",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "duration",
"type" : "Number",
"desc" : "The length of time (in seconds) that the effect should last",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "easing",
"type" : "String",
"desc" : "A valid Easing value for the effect",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "remove",
"type" : "Boolean",
"desc" : "Whether the Element should be removed from the DOM and destroyed after the effect finishes",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "scope",
"type" : "Object",
"desc" : "The scope of the effect function",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "stopFx",
"type" : "Boolean",
"desc" : "Whether subsequent effects should be stopped and removed after the current effect finishes",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
},
{
"name" : "useDisplay",
"type" : "Boolean",
"desc" : "Whether to use the <i>display</i> CSS property instead of <i>visibility</i> when hiding Elements (only applies to \neffects that end with the element being visually hidden, ignored otherwise)",
- "memberOf" : ""
+ "memberOf" : "Roo.Fx"
}
],
"events" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.GridPanel" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.HtmlEditorCore" : {
"props" : [
"name" : "allowComments",
"type" : "boolean",
"desc" : "- default false - allow comments in HTML source - by default they are stripped - if you are editing email you may need this.",
- "memberOf" : ""
+ "memberOf" : "Roo.HtmlEditorCore"
},
{
"name" : "allowDomMove",
"name" : "height",
"type" : "Number",
"desc" : "(in pixels)",
- "memberOf" : ""
+ "memberOf" : "Roo.HtmlEditorCore"
},
{
"name" : "hideMode",
"name" : "resizable",
"type" : "String",
"desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
+ "memberOf" : "Roo.HtmlEditorCore"
},
{
"name" : "stylesheets",
"type" : "Array",
"desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : ""
+ "memberOf" : "Roo.HtmlEditorCore"
},
{
"name" : "the",
"type" : "Roo.form.HtmlEditor|Roo.bootstrap.HtmlEditor",
"desc" : "owner field",
- "memberOf" : ""
+ "memberOf" : "Roo.HtmlEditorCore"
},
{
"name" : "width",
"type" : "Number",
"desc" : "(in pixels)",
- "memberOf" : ""
+ "memberOf" : "Roo.HtmlEditorCore"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.JsonView" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.KeyMap" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.KeyNav" : {
"props" : [
"name" : "defaultEventAction",
"type" : "String",
"desc" : "The method to call on the {@link Roo.EventObject} after this KeyNav intercepts a key. Valid values are\n{@link Roo.EventObject#stopEvent}, {@link Roo.EventObject#preventDefault} and\n{@link Roo.EventObject#stopPropagation} (defaults to 'stopEvent')",
- "memberOf" : ""
+ "memberOf" : "Roo.KeyNav"
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable this KeyNav instance (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.KeyNav"
},
{
"name" : "forceKeyDown",
"type" : "Boolean",
"desc" : "Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since\nIE does not propagate special keys on keypress, but setting this to true will force other browsers to also\nhandle keydown instead of keypress.",
- "memberOf" : ""
+ "memberOf" : "Roo.KeyNav"
}
],
"events" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Layer" : {
"props" : [
"name" : "cls",
"type" : "String",
"desc" : "CSS class to add to the element",
- "memberOf" : ""
+ "memberOf" : "Roo.Layer"
},
{
"name" : "constrain",
"type" : "Boolean",
"desc" : "False to disable constrain to viewport (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Layer"
},
{
"name" : "dh",
"type" : "Object",
"desc" : "DomHelper object config to create element with (defaults to {tag: \"div\", cls: \"x-layer\"}).",
- "memberOf" : ""
+ "memberOf" : "Roo.Layer"
},
{
"name" : "shadow",
"type" : "String/Boolean",
"desc" : "True to create a shadow element with default class \"x-layer-shadow\", or\nyou can pass a string with a CSS class name. False turns off the shadow.",
- "memberOf" : ""
+ "memberOf" : "Roo.Layer"
},
{
"name" : "shadowOffset",
"type" : "Number",
"desc" : "Number of pixels to offset the shadow (defaults to 3)",
- "memberOf" : ""
+ "memberOf" : "Roo.Layer"
},
{
"name" : "shim",
"type" : "Boolean",
"desc" : "False to disable the iframe shim in browsers which need one (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Layer"
},
{
"name" : "zindex",
"type" : "Number",
"desc" : "Starting z-index (defaults to 11000)",
- "memberOf" : ""
+ "memberOf" : "Roo.Layer"
}
],
"events" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.LayoutDialog" : {
"props" : [
"name" : "buttons[]",
"type" : "Roo.Button",
"desc" : "Bottom buttons..",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutDialog"
},
{
"name" : "center",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutDialog"
},
{
"name" : "closable",
"name" : "east",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutDialog"
},
{
"name" : "fixedcenter",
"name" : "north",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutDialog"
},
{
"name" : "proxyDrag",
"name" : "south",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutDialog"
},
{
"name" : "syncHeightBeforeShow",
"name" : "west",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutDialog"
},
{
"name" : "width",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : true,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.ContentPanel",
+ "Roo.GridPanel",
+ "Roo.NestedLayoutPanel",
+ "Roo.TreePanel"
+ ],
+ "tree_parent" : []
},
"Roo.LayoutManager" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.BorderLayout" : [
+ "Roo.ReaderLayout"
+ ],
+ "Roo.LayoutManager" : [
+ "Roo.BorderLayout"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.LayoutRegion" : {
"props" : [
"name" : "alwaysShowTabs",
"type" : "Boolean",
"desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "autoHide",
"type" : "Boolean",
"desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "closeOnTab",
"type" : "Boolean",
"desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "cmargins",
"type" : "Object",
"desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "collapsed",
"type" : "Boolean",
"desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "collapsedTitle",
"type" : "String",
"desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "collapsible",
"type" : "Boolean",
"desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "disableTabTips",
"type" : "Boolean",
"desc" : "True to disable tab tooltips",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "floatable",
"type" : "Boolean",
"desc" : "False to disable floating (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "height",
"type" : "Number",
"desc" : "For North/South panels",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "hideTabs",
"type" : "Boolean",
"desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "hideWhenEmpty",
"type" : "Boolean",
"desc" : "True to hide the region when it has no panels",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "listeners",
"name" : "margins",
"type" : "Object",
"desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "minTabWidth",
"type" : "Number",
"desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "preferredTabWidth",
"type" : "Number",
"desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "preservePanels",
"type" : "Boolean",
"desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "showPin",
"type" : "Boolean",
"desc" : "True to show a pin button",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "split",
"type" : "Boolean",
"desc" : "To show the splitter",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "tabPosition",
"type" : "String",
"desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for the region (overrides panel titles)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "titlebar",
"type" : "Boolean",
"desc" : "True to display a title bar (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "toolbar",
"type" : "Boolean",
"desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "width",
"type" : "Number",
"desc" : "For East/West panels",
- "memberOf" : ""
+ "memberOf" : "Roo.LayoutRegion"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.LayoutRegion" : [
+ "Roo.SplitLayoutRegion",
+ "Roo.bootstrap.layout.Split"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.LoadMask" : {
"props" : [
"name" : "msg",
"type" : "String",
"desc" : "The text to display in a centered loading message box (defaults to 'Loading...')",
- "memberOf" : ""
+ "memberOf" : "Roo.LoadMask"
},
{
"name" : "msgCls",
"type" : "String",
"desc" : "The CSS class to apply to the loading message element (defaults to \"x-mask-loading\")",
- "memberOf" : ""
+ "memberOf" : "Roo.LoadMask"
},
{
"name" : "removeMask",
"type" : "Boolean",
"desc" : "True to create a single-use mask that is automatically destroyed after loading (useful for page loads),\nFalse to persist the mask element reference for multiple uses (e.g., for paged data widgets). Defaults to false.",
- "memberOf" : ""
+ "memberOf" : "Roo.LoadMask"
}
],
"events" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.MasterTemplate" : {
"props" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.NestedLayoutPanel" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.PagingToolbar" : {
"props" : [
"name" : "container",
"type" : "String/HTMLElement/Element",
"desc" : "container The id or element that will contain the toolbar",
- "memberOf" : ""
+ "memberOf" : "Roo.PagingToolbar"
},
{
"name" : "displayInfo",
"type" : "Boolean",
"desc" : "True to display the displayMsg (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.PagingToolbar"
},
{
"name" : "displayMsg",
"type" : "String",
"desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
- "memberOf" : ""
+ "memberOf" : "Roo.PagingToolbar"
},
{
"name" : "emptyMsg",
"type" : "String",
"desc" : "The message to display when no records are found (defaults to \"No data to display\")",
- "memberOf" : ""
+ "memberOf" : "Roo.PagingToolbar"
},
{
"name" : "items",
"name" : "pageSize",
"type" : "Number",
"desc" : "The number of records to display per page (defaults to 20)",
- "memberOf" : ""
+ "memberOf" : "Roo.PagingToolbar"
},
{
"name" : "text",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.Toolbar.Item",
+ "Roo.Toolbar.Fill",
+ "Roo.Toolbar.Separator",
+ "Roo.Toolbar.Spacer",
+ "Roo.Toolbar.TextItem",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField"
+ ],
+ "tree_parent" : []
},
"Roo.QuickTips" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.ReaderLayout" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Resizable" : {
"props" : [
"name" : "adjustments",
"type" : "Array/String",
"desc" : "String \"auto\" or an array [width, height] with values to be <b>added</b> to the\nresize operation's new size (defaults to [0, 0])",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "True to animate the resize (not compatible with dynamic sizing, defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "constrainTo",
"type" : "String/HTMLElement/Element",
"desc" : "Constrain the resize to a particular element",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "disableTrackOver",
"type" : "Boolean",
"desc" : "True to disable mouse tracking. This is only applied at config time. (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "draggable",
"type" : "Boolean",
"desc" : "Convenience to initialize drag drop (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "duration",
"type" : "Number",
"desc" : "Animation duration if animate = true (defaults to .35)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "dynamic",
"type" : "Boolean",
"desc" : "True to resize the element while dragging instead of using a proxy (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "easing",
"type" : "String",
"desc" : "Animation easing if animate = true (defaults to 'easingOutStrong')",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "enabled",
"type" : "Boolean",
"desc" : "False to disable resizing (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "handles",
"type" : "String",
"desc" : "String consisting of the resize handles to display (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "height",
"type" : "Number",
"desc" : "The height of the element in pixels (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "heightIncrement",
"type" : "Number",
"desc" : "The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "listeners",
"name" : "maxHeight",
"type" : "Number",
"desc" : "The maximum height for the element (defaults to 10000)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "maxWidth",
"type" : "Number",
"desc" : "The maximum width for the element (defaults to 10000)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "minHeight",
"type" : "Number",
"desc" : "The minimum height for the element (defaults to 5)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width for the element (defaults to 5)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "minX",
"type" : "Number",
"desc" : "The minimum allowed page X for the element (only used for west resizing, defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "minY",
"type" : "Number",
"desc" : "The minimum allowed page Y for the element (only used for north resizing, defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "multiDirectional",
"type" : "Boolean",
"desc" : "<b>Deprecated</b>. The old style of adding multi-direction resize handles, deprecated\nin favor of the handles config option (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "pinned",
"type" : "Boolean",
"desc" : "True to ensure that the resize handles are always visible, false to display them only when the\nuser mouses over the resizable borders. This is only applied at config time. (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "preserveRatio",
"type" : "Boolean",
"desc" : "True to preserve the original ratio between height and width during resize (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "resizeChild",
"type" : "Boolean/String/Element",
"desc" : "True to resize the first child, or id/element to resize (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "resizeRegion",
"type" : "Roo.lib.Region",
"desc" : "Constrain the resize to a particular region",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "transparent",
"type" : "Boolean",
"desc" : "True for transparent handles. This is only applied at config time. (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "width",
"type" : "Number",
"desc" : "The width of the element in pixels (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "widthIncrement",
"type" : "Number",
"desc" : "The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
},
{
"name" : "wrap",
"type" : "Boolean",
"desc" : "True to wrap an element with a div if needed (required for textareas and images, defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.Resizable"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Shadow" : {
"props" : [
"name" : "mode",
"type" : "String",
"desc" : "The shadow display mode. Supports the following options:<br />\nsides: Shadow displays on both sides and bottom only<br />\nframe: Shadow displays equally on all four sides<br />\ndrop: Traditional bottom-right drop shadow (default)",
- "memberOf" : ""
+ "memberOf" : "Roo.Shadow"
},
{
"name" : "offset",
"type" : "String",
"desc" : "The number of pixels to offset the shadow from the element (defaults to 4)",
- "memberOf" : ""
+ "memberOf" : "Roo.Shadow"
}
],
"events" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.SplitBar" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.SplitBar.AbsoluteLayoutAdapter" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.SplitBar.BasicLayoutAdapter" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.SplitBar.BasicLayoutAdapter" : [
+ "Roo.SplitBar.AbsoluteLayoutAdapter"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.SplitButton" : {
"props" : [
"name" : "arrowHandler",
"type" : "Function",
"desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
- "memberOf" : ""
+ "memberOf" : "Roo.SplitButton"
},
{
"name" : "arrowTooltip",
"type" : "String",
"desc" : "The title attribute of the arrow",
- "memberOf" : ""
+ "memberOf" : "Roo.SplitButton"
},
{
"name" : "clickEvent",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.SplitButton" : [
+ "Roo.Toolbar.SplitButton"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.SplitLayoutRegion" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.TabPanel" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.TabPanelItem" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Template" : {
"props" : [
"name" : "html",
"type" : "String",
"desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
- "memberOf" : ""
+ "memberOf" : "Roo.Template"
},
{
"name" : "onLoad",
"type" : "Function",
"desc" : "Called after the template has been loaded and complied (usually from a remove source)",
- "memberOf" : ""
+ "memberOf" : "Roo.Template"
},
{
"name" : "url",
"type" : "String",
"desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
- "memberOf" : ""
+ "memberOf" : "Roo.Template"
}
],
"events" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.Template" : [
+ "Roo.DomTemplate",
+ "Roo.MasterTemplate",
+ "Roo.XTemplate"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Toolbar" : {
"props" : [
"name" : "container",
"type" : "String/HTMLElement/Element",
"desc" : "The id or element that will contain the toolbar",
- "memberOf" : ""
+ "memberOf" : "Roo.Toolbar"
},
{
"name" : "items",
"type" : "Array",
"desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
- "memberOf" : ""
+ "memberOf" : "Roo.Toolbar"
},
{
"name" : "text",
"type" : "string",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.Toolbar"
}
],
"events" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.Toolbar" : [
+ "Roo.PagingToolbar"
+ ]
+ },
+ "tree_children" : [
+ "Roo.Toolbar.Item",
+ "Roo.Toolbar.Fill",
+ "Roo.Toolbar.Separator",
+ "Roo.Toolbar.Spacer",
+ "Roo.Toolbar.TextItem",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField"
+ ],
+ "tree_parent" : []
},
"Roo.Toolbar.Button" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Toolbar.Fill" : {
"props" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Toolbar.Item" : {
"props" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.Toolbar.Spacer" : [
+ "Roo.Toolbar.Fill"
+ ],
+ "Roo.Toolbar.Item" : [
+ "Roo.Toolbar.Separator",
+ "Roo.Toolbar.Spacer",
+ "Roo.Toolbar.TextItem"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Toolbar.Separator" : {
"props" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Toolbar.Spacer" : {
"props" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.Toolbar.Spacer" : [
+ "Roo.Toolbar.Fill"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Toolbar.SplitButton" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.Toolbar.TextItem" : {
"props" : [
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.TreePanel" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.UpdateManager" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.UpdateManager.BasicRenderer" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.UpdateManager.defaults" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.View" : {
"props" : [
"name" : "dataName",
"type" : "String",
"desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "el",
"type" : "String|Roo.Element",
"desc" : "The container element.",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "emptyText",
"type" : "String",
"desc" : "The empty text to show when nothing is loaded.",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "listeners",
"name" : "multiSelect",
"type" : "Boolean",
"desc" : "Allow multiple selection",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "selectedClass",
"type" : "String",
"desc" : "The css class to add to selected nodes",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "singleSelect",
"type" : "Boolean",
"desc" : "Allow single selection",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "Data store to load data from.",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "text",
"type" : "String",
"desc" : "to display on mask (default Loading)",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "tickable",
"type" : "Boolean",
"desc" : "- selecting",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "toggleSelect",
"type" : "Boolean",
"desc" : "- selecting",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
},
{
"name" : "tpl",
"type" : "String|Roo.Template",
"desc" : "The template used by this View",
- "memberOf" : ""
+ "memberOf" : "Roo.View"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.View" : [
+ "Roo.JsonView"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.XComponent" : {
"props" : [
"name" : "disabled",
"type" : "Function|boolean",
"desc" : "If this module is disabled by some rule, return true from the funtion",
- "memberOf" : ""
+ "memberOf" : "Roo.XComponent"
},
{
"name" : "items",
"type" : "Array",
"desc" : "A single item array - the first element is the root of the tree..\nIt's done this way to stay compatible with the Xtype system...",
- "memberOf" : ""
+ "memberOf" : "Roo.XComponent"
},
{
"name" : "listeners",
"name" : "name",
"type" : "String",
"desc" : "String to display while loading.",
- "memberOf" : ""
+ "memberOf" : "Roo.XComponent"
},
{
"name" : "order",
"type" : "String",
"desc" : "Used to set the order in which elements are created (usefull for multiple tabs)",
- "memberOf" : ""
+ "memberOf" : "Roo.XComponent"
},
{
"name" : "parent",
"type" : "String",
"desc" : "Name of parent element which it get xtype added to..",
- "memberOf" : ""
+ "memberOf" : "Roo.XComponent"
},
{
"name" : "region",
"type" : "String",
"desc" : "Region to render component to (defaults to center)",
- "memberOf" : ""
+ "memberOf" : "Roo.XComponent"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.XComponent.event.events" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.XTemplate" : {
"props" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.bootstrap" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.bootstrap.Alert" : {
"props" : [
"name" : "close",
"type" : "Boolean",
"desc" : "true to show a x closer",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Alert"
},
{
"name" : "cls",
"name" : "fa",
"type" : "String",
"desc" : "font-awesomeicon",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Alert"
},
{
"name" : "hideMode",
"name" : "html",
"type" : "String",
"desc" : "The content of alert",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Alert"
},
{
"name" : "listeners",
"name" : "seconds",
"type" : "Number",
"desc" : "default:-1 Number of seconds until it disapears (-1 means never.)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Alert"
},
{
"name" : "style",
"name" : "title",
"type" : "String",
"desc" : "The title of alert",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Alert"
},
{
"name" : "tooltip",
"name" : "weight",
"type" : "String",
"desc" : "r) Weight of the message",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Alert"
},
{
"name" : "xattr",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"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" : ""
+ "memberOf" : "Roo.bootstrap.BezierSignature"
},
{
"name" : "Callback",
"type" : "function",
"desc" : "when stroke begin.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.BezierSignature"
},
{
"name" : "Color",
"type" : "string",
"desc" : "used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to \"black\".",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.BezierSignature"
},
{
"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" : ""
+ "memberOf" : "Roo.bootstrap.BezierSignature"
},
{
"name" : "Maximum",
"type" : "float",
"desc" : "width of a line. Defaults to 2.5.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.BezierSignature"
},
{
"name" : "Minimum",
"type" : "float",
"desc" : "width of a line. Defaults to 0.5.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.BezierSignature"
},
{
"name" : "Radius",
"type" : "float|function",
"desc" : "of a single dot.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.BezierSignature"
},
{
"name" : "Weight",
"type" : "float",
"desc" : "used to modify new velocity based on the previous velocity. Defaults to 0.7.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.BezierSignature"
},
{
"name" : "actionMode",
"name" : "canvas",
"type" : "int",
"desc" : "height",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.BezierSignature"
},
{
"name" : "cls",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.bootstrap.Body" : {
"props" : [
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : true,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "none"
]
},
"Roo.bootstrap.Brick" : {
"name" : "bgimage",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Brick"
},
{
"name" : "can_build_overlaid",
"name" : "cls",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Brick"
},
{
"name" : "container_method",
"name" : "href",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Brick"
},
{
"name" : "html",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Brick"
},
{
"name" : "listeners",
"name" : "square",
"type" : "Boolean",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Brick"
},
{
"name" : "style",
"name" : "title",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Brick"
},
{
"name" : "tooltip",
"name" : "video",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Brick"
},
{
"name" : "visibilityEl",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.bootstrap.Button" : {
"props" : [
"name" : "badge",
"type" : "String",
"desc" : "text for badge",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "badge_weight",
"type" : "String",
"desc" : "k) default (same as button)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "can_build_overlaid",
"name" : "disabled",
"type" : "Boolean",
"desc" : "default false;",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "fa",
"type" : "String",
"desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "glyphicon",
"type" : "String",
"desc" : "depricated - use fa",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "grpup",
"type" : "Boolean",
"desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "hideMode",
"name" : "href",
"type" : "String",
"desc" : "empty or href",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "html",
"type" : "String",
"desc" : "The button content",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "dark themed version",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "isClose",
"type" : "Boolean",
"desc" : "default false;",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "listeners",
},
{
"name" : "menu",
- "type" : "Roo.bootstrap.Menu",
+ "type" : "Roo.bootstrap.menu.Menu",
"desc" : "a Menu",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "name",
"name" : "offtext",
"type" : "String",
"desc" : "text for off slidy toggle state",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "ontext",
"type" : "String",
"desc" : "text for on slidy toggle state",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "outline",
"type" : "Boolean",
"desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "default null - if the button ahs active state",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "preventDefault",
"type" : "Boolean",
"desc" : "default true (stop click event triggering the URL if it's a link.)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "removeClass",
"type" : "Boolean",
"desc" : "remove the standard class..",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "size",
"type" : "String",
"desc" : "s)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "style",
"name" : "tag",
"type" : "String",
"desc" : "t)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "target",
"type" : "String",
"desc" : "r) target for a href.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "theme",
"type" : "String",
"desc" : "w)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "toggle",
"type" : "Boolean",
"desc" : "is it a slidy toggle button",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "tooltip",
"name" : "weight",
"type" : "String",
"desc" : "k) default",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "xattr",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.Button" : [
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.bootstrap.ButtonGroup" : {
"props" : [
"name" : "align",
"type" : "String",
"desc" : "vertical | justified (default none)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.ButtonGroup"
},
{
"name" : "allowDomMove",
"name" : "btn",
"type" : "Boolean",
"desc" : "true | false",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.ButtonGroup"
},
{
"name" : "can_build_overlaid",
"name" : "direction",
"type" : "String",
"desc" : "up | down (default down)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.ButtonGroup"
},
{
"name" : "disableClass",
"name" : "size",
"type" : "String",
"desc" : "lg | sm | xs (default empty normal)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.ButtonGroup"
},
{
"name" : "style",
"name" : "toolbar",
"type" : "Boolean",
"desc" : "false | true",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.ButtonGroup"
},
{
"name" : "tooltip",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.Form"
+ ],
+ "tree_parent" : []
},
"Roo.bootstrap.ButtonUploader" : {
"props" : [
"name" : "errorTimeout",
"type" : "Number",
"desc" : "default 3000",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.ButtonUploader"
},
{
"name" : "fa",
"name" : "html",
"type" : "Array",
"desc" : "The button text.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.ButtonUploader"
},
{
"name" : "images",
"type" : "Array",
"desc" : "an array of ?? Img objects ??? when loading existing files..",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.ButtonUploader"
},
{
"name" : "inverse",
},
{
"name" : "menu",
- "type" : "Roo.bootstrap.Menu",
+ "type" : "Roo.bootstrap.menu.Menu",
"desc" : "a Menu",
"memberOf" : "Roo.bootstrap.Button"
},
"name" : "multiple",
"type" : "Boolean",
"desc" : "(default true) Should the upload allow multiple files to be uploaded.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.ButtonUploader"
},
{
"name" : "name",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.bootstrap.Calendar" : {
"props" : [
"name" : "header",
"type" : "Object",
"desc" : "generate the user specific header of the calendar, default false",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Calendar"
},
{
"name" : "hideMode",
"name" : "loadMask",
"type" : "Boolean",
"desc" : "e) default false",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Calendar"
},
{
"name" : "name",
"name" : "startDay",
"type" : "Number",
"desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Calendar"
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "The data source for the calendar",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Calendar"
},
{
"name" : "style",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.bootstrap.Card" : {
"props" : [
"name" : "display",
"type" : "String",
"desc" : "x)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "display_lg",
"type" : "String",
"desc" : "x)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "display_sm",
"type" : "String",
"desc" : "x)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "display_xl",
"type" : "String",
"desc" : "x)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "display_xs",
"type" : "String",
"desc" : "x)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "footer",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "header",
"type" : "String|Object",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "header_image",
"type" : "String",
"desc" : "src url of image.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "header_size",
"type" : "Number",
"desc" : "5) H1 or H2 etc.. 0 indicates default",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "header_weight",
"type" : "Number",
"desc" : "k)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "hideMode",
"name" : "html",
"type" : "String|Boolean",
"desc" : "-- html contents - or just use children.. use false to hide it..",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "listeners",
"name" : "margin",
"type" : "String",
"desc" : "o)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "margin_bottom",
"type" : "String",
"desc" : "o)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "margin_left",
"type" : "String",
"desc" : "o)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "margin_right",
"type" : "String",
"desc" : "o)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "margin_top",
"type" : "String",
"desc" : "o)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "margin_x",
"type" : "String",
"desc" : "o)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "margin_y",
"type" : "String",
"desc" : "o)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "name",
"name" : "padding",
"type" : "String",
"desc" : "5)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "padding_bottom",
"type" : "String",
"desc" : "5)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "padding_left",
"type" : "String",
"desc" : "5)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "padding_right",
"type" : "String",
"desc" : "5)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "padding_top",
"type" : "String",
"desc" : "5)next_to_card",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "padding_x",
"type" : "String",
"desc" : "5)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "padding_y",
"type" : "String",
"desc" : "5)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "style",
"name" : "subtitle",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "title",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "tooltip",
"name" : "weight",
"type" : "String",
"desc" : "k)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Card"
},
{
"name" : "xattr",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
"Roo.bootstrap.CardFooter" : {
"props" : [
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.Card"
]
},
"Roo.bootstrap.CardHeader" : {
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.Card"
]
},
"Roo.bootstrap.CardImageTop" : {
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.Card"
]
},
- "Roo.bootstrap.CardUploader" : {
+ "Roo.bootstrap.Column" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "alert",
+ "type" : "String",
+ "desc" : "r) type alert (changes background / border...)",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"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" : "k) default (same as button)",
- "memberOf" : "Roo.bootstrap.Button"
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "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"
+ "desc" : ".) font awesome icon",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "depricated - use fa",
- "memberOf" : "Roo.bootstrap.Button"
+ "name" : "fasize",
+ "type" : "Number",
+ "desc" : ".) font awsome size",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "grpup",
+ "name" : "hidden",
"type" : "Boolean",
- "desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "e) hide the element",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
"name" : "hideMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "empty or href",
- "memberOf" : "Roo.bootstrap.Button"
- },
{
"name" : "html",
- "type" : "Array",
- "desc" : "The button text.",
- "memberOf" : ""
+ "type" : "String",
+ "desc" : "content of column.",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "images",
- "type" : "Array",
- "desc" : "an array of ?? Img objects ??? when loading existing files..",
- "memberOf" : ""
+ "name" : "icon",
+ "type" : "String",
+ "desc" : ".) glyphicon name",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "dark themed version",
- "memberOf" : "Roo.bootstrap.Button"
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "isClose",
- "type" : "Boolean",
- "desc" : "default false;",
- "memberOf" : "Roo.bootstrap.Button"
+ "name" : "lgoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "menu",
- "type" : "Roo.bootstrap.Menu",
- "desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.Button"
+ "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",
"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" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
- "name" : "size",
- "type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.Button"
+ "name" : "smoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Button"
- },
- {
- "name" : "target",
- "type" : "String",
- "desc" : "r) target for a href.",
- "memberOf" : "Roo.bootstrap.Button"
- },
- {
- "name" : "theme",
- "type" : "String",
- "desc" : "w)",
- "memberOf" : "Roo.bootstrap.Button"
- },
- {
- "name" : "toggle",
- "type" : "Boolean",
- "desc" : "is it a slidy toggle button",
- "memberOf" : "Roo.bootstrap.Button"
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "k) default",
- "memberOf" : "Roo.bootstrap.Button"
- },
{
"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" : [
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "When a button is pressed",
- "sig" : "function (btn, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Button",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "dblclick",
- "type" : "function",
- "desc" : "When a button is double clicked",
- "sig" : "function (btn, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Button",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "download",
- "type" : "function",
- "desc" : "When a the download link is clicked",
- "sig" : "function (_self, The)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Card",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "The",
- "type" : "Object",
- "desc" : "image information data contains",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "preview",
- "type" : "function",
- "desc" : "When a image is clicked on - and needs to display a slideshow or similar..",
- "sig" : "function (_self, The)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Card",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "The",
- "type" : "Object",
- "desc" : "image information data",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "toggle",
- "type" : "function",
- "desc" : "After the button has been toggles",
- "sig" : "function (btn, e, pressed)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Button",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "btn",
- "type" : "Roo.bootstrap.Button",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "pressed",
- "type" : "boolean",
- "desc" : "(also available as button.pressed)",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
- {
- "name" : "addCard",
- "type" : "function",
- "desc" : "addCard - add an Attachment to the uploader",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "",
- "desc" : "- the data about the image to upload\n\n{\n id : 123\n title : \"Title of file\",\n is_uploaded : false,\n src : \"http://.....\",\n srcfile : { the File upload object },\n mimetype : file.type,\n preview : false,\n is_deleted : 0\n .. any other data...\n }",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this button",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "enable",
"type" : "function",
- "desc" : "Enables this button",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Button",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "fireEvent",
}
]
},
- {
- "name" : "getText",
- "type" : "function",
- "desc" : "get the text of the first selected button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "isActive",
- "type" : "function",
- "desc" : "get the current active state",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if it's active"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setActive",
- "type" : "function",
- "desc" : "sets the active state on/off,",
- "sig" : "(state)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "state",
- "type" : "Boolean",
- "desc" : "(optional) Force a particular state",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setText",
- "type" : "function",
- "desc" : "set the text of the first selected button",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "toggleActive",
- "type" : "function",
- "desc" : "toggles the current active state",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Button",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "tooltipEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.Column" : [
+ "Roo.bootstrap.TabGroup"
+ ]
+ },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.CheckBox" : {
+ "Roo.bootstrap.Component" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "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" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "initnal the element",
- "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" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "groupId",
- "type" : "String",
- "desc" : "the checkbox group id // normal just use for checkbox",
- "memberOf" : ""
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "inline",
- "type" : "Boolean",
- "desc" : "inline the element (default false)",
- "memberOf" : ""
- },
- {
- "name" : "inputValue",
- "type" : "String",
- "desc" : "The value that should go into the generated input element's value when checked.",
- "memberOf" : ""
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "style",
},
{
"name" : "tooltip",
- "type" : "String",
- "desc" : "label tooltip",
- "memberOf" : ""
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "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",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "s) The text that appears beside the checkbox",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the element is checked or unchecked.",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.CheckBox",
- "desc" : "This input",
- "isOptional" : false
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "The new checked value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
"desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when the element is click.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.CheckBox",
- "desc" : "This input",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a CheckBox Group based on the group ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "group ID",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
"desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
"memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a CheckBox Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.CheckBox",
- "desc" : "CheckBox to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
- ]
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.nav.Bar" : [
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "Roo.bootstrap.nav.Simplebar" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.nav.Headerbar"
+ ],
+ "Roo.bootstrap.Button" : [
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ],
+ "Roo.bootstrap.Column" : [
+ "Roo.bootstrap.TabGroup"
+ ],
+ "Roo.bootstrap.form.TriggerField" : [
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.PhoneInput"
+ ],
+ "Roo.bootstrap.form.TextArea" : [
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown"
+ ],
+ "Roo.bootstrap.layout.Manager" : [
+ "Roo.bootstrap.layout.Border"
+ ],
+ "Roo.bootstrap.Element" : [
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.DropTarget"
+ ],
+ "Roo.bootstrap.nav.Item" : [
+ "Roo.bootstrap.nav.SidebarItem"
+ ],
+ "Roo.bootstrap.Component" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Body",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Modal",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.Popover",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.TableBody",
+ "Roo.bootstrap.TableCell",
+ "Roo.bootstrap.TableRow",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Item",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.layout.Manager",
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Menu",
+ "Roo.bootstrap.menu.Separator",
+ "Roo.bootstrap.nav.Bar",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem"
+ ],
+ "Roo.bootstrap.form.ComboBox" : [
+ "Roo.bootstrap.form.MoneyField"
+ ],
+ "Roo.bootstrap.form.Input" : [
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField"
+ ]
+ },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.Column" : {
+ "Roo.bootstrap.Container" : {
"props" : [
{
"name" : "actionMode",
"name" : "alert",
"type" : "String",
"desc" : "r) type alert (changes background / border...)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Container"
},
{
"name" : "allowDomMove",
"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.Container"
+ },
{
"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" : "Roo.bootstrap.Container"
+ },
+ {
+ "name" : "expanded",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.Container"
+ },
{
"name" : "fa",
"type" : "String",
- "desc" : ".) font awesome icon",
- "memberOf" : ""
+ "desc" : "font awesome icon",
+ "memberOf" : "Roo.bootstrap.Container"
},
{
- "name" : "fasize",
- "type" : "Number",
- "desc" : ".) font awsome size",
- "memberOf" : ""
+ "name" : "footer",
+ "type" : "String",
+ "desc" : "content of footer (for panel)",
+ "memberOf" : "Roo.bootstrap.Container"
+ },
+ {
+ "name" : "header",
+ "type" : "String",
+ "desc" : "content of header (for panel)",
+ "memberOf" : "Roo.bootstrap.Container"
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "e) hide the element",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Container"
},
{
"name" : "hideMode",
{
"name" : "html",
"type" : "String",
- "desc" : "content of column.",
- "memberOf" : ""
+ "desc" : "content of element",
+ "memberOf" : "Roo.bootstrap.Container"
},
{
"name" : "icon",
"type" : "String",
"desc" : ".) glyphicon name",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Container"
},
{
- "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" : "jumbotron",
+ "type" : "Boolean",
+ "desc" : "is it a jumbotron element",
+ "memberOf" : "Roo.bootstrap.Container"
},
{
"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" : "panel",
+ "type" : "String",
+ "desc" : "r) render as panel - type - primary/success.....",
+ "memberOf" : "Roo.bootstrap.Container"
},
{
- "name" : "smoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : ""
+ "name" : "rheader",
+ "type" : "String",
+ "desc" : "contet on the right of header",
+ "memberOf" : "Roo.bootstrap.Container"
+ },
+ {
+ "name" : "sticky",
+ "type" : "String",
+ "desc" : "h) block to use as footer or body- needs css-bootstrap/sticky-footer.css",
+ "memberOf" : "Roo.bootstrap.Container"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "n) type of HTML tag.",
+ "memberOf" : "Roo.bootstrap.Container"
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "well",
+ "type" : "String",
+ "desc" : "d) a well, large, small or medium.",
+ "memberOf" : "Roo.bootstrap.Container"
+ },
{
"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" : [
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Container",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "After the panel has been collapsed",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Container",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "After the panel has been expand",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Container",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : true,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.ComboBox" : {
+ "Roo.bootstrap.DocumentManager" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "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",
"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" : "e) default 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" : "e) auto focus the first item, default true",
- "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" : "boxes",
+ "type" : "Number",
+ "desc" : "number of boxes, 0 is no limit.. default 0",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "cls",
"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.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" : "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" : "emptyResultText",
- "type" : "Boolean",
- "desc" : "only for touch device",
- "memberOf" : ""
- },
- {
- "name" : "emptyTitle",
- "type" : "String",
- "desc" : "default ''",
- "memberOf" : ""
+ "desc" : "e) allow edit when upload a image default true",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : ""
- },
- {
- "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" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "hideMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : ""
- },
- {
- "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"
+ "desc" : "p) default left",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "labelWidth",
"type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "default 4",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : ""
- },
- {
- "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" : ""
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "listeners",
"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.bootstrap.Input"
- },
- {
- "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" : "e) show mobile touch view when using a mobile default true",
- "memberOf" : ""
- },
- {
- "name" : "mobile_restrict_height",
- "type" : "Boolean",
- "desc" : "e) restrict height for touch view",
- "memberOf" : ""
- },
- {
- "name" : "modalTitle",
- "type" : "String",
- "desc" : "The title of the dialog that pops up on mobile views.",
- "memberOf" : ""
- },
- {
- "name" : "mode",
+ "name" : "method",
"type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : ""
+ "desc" : "default POST",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "multiple",
"type" : "Boolean",
- "desc" : "e) ComboBobArray, default false",
- "memberOf" : ""
+ "desc" : "multiple upload default true",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "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" : "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" : ""
- },
- {
- "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" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : ""
- },
- {
- "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" : ""
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "selectedClass",
+ "name" : "paramName",
"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" : ""
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "specialFilter",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : ""
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "default 'imageUpload'",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tickable",
- "type" : "Boolean",
- "desc" : "ComboBox with tickable selections (true|false), default false",
- "memberOf" : ""
+ "name" : "thumbSize",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
- "name" : "title",
+ "name" : "toolTipName",
"type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : ""
+ "desc" : "default 'filename'",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "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" : "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' 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" : ""
- },
- {
- "name" : "triggerText",
- "type" : "String",
- "desc" : "multiple combobox trigger button text default 'Select'",
- "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" : "useNativeIOS",
- "type" : "Boolean",
- "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
- "memberOf" : ""
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "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" : "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" : ""
- },
- {
- "name" : "valueNotFoundText",
+ "name" : "url",
"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" : "action url",
+ "memberOf" : "Roo.bootstrap.DocumentManager"
},
{
"name" : "visibilityEl",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "fixed with? experimental",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
{
- "name" : "add",
+ "name" : "afterupload",
"type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
+ "desc" : "Fire when xhr load exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "afterremove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
"returns" : []
},
{
- "name" : "beforeselect",
+ "name" : "beforeselectfile",
"type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "blur",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Fire after click the image",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "file",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"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}",
+ "desc" : "Fire when upload a image and editable set to true",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "expand",
+ "name" : "exception",
"type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
+ "desc" : "Fire when xhr load exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "initial",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Fire when initial the DocumentManager",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "inspect",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "inspect selected file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "file",
+ "type" : "File",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paste",
+ "name" : "prepare",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "prepare the form data",
+ "sig" : "function (_self, formData)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "formData",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "previewrendered",
"type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
+ "desc" : "Fire when preview rendered",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "file",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "select",
+ "name" : "process",
"type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
+ "desc" : "Fire before process file",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentManager",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fire after refresh the file",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "specialfilter",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires when specialfilter",
- "sig" : "function (combo)\n{\n\n}",
+ "desc" : "Fire when remove the file",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.DocumentManager",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "tick",
- "type" : "function",
- "desc" : "Fires when tick the element",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "touchviewdisplay",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when touch view require special display (default is using displayField)",
- "sig" : "function (combo, cfg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "set html .",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "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",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getName",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns the name of the field",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "value The selected value"
- }
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The value to match",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Component" : {
+ "Roo.bootstrap.DocumentSlider" : {
"props" : [
{
"name" : "actionMode",
"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",
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"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",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fire after click",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentSlider",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initial",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentSlider",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "update",
+ "type" : "function",
+ "desc" : "Fire after update",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentSlider",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
"desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Container" : {
+ "Roo.bootstrap.DocumentViewer" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "alert",
- "type" : "String",
- "desc" : "r) type alert (changes background / border...)",
- "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" : ""
- },
{
"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" : ""
- },
- {
- "name" : "expanded",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
- },
- {
- "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" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of element",
- "memberOf" : ""
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : ".) glyphicon name",
- "memberOf" : ""
- },
- {
- "name" : "jumbotron",
- "type" : "Boolean",
- "desc" : "is it a jumbotron element",
- "memberOf" : ""
- },
{
"name" : "listeners",
"type" : "Object",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "panel",
- "type" : "String",
- "desc" : "r) render as panel - type - primary/success.....",
- "memberOf" : ""
- },
- {
- "name" : "rheader",
- "type" : "String",
- "desc" : "contet on the right of header",
- "memberOf" : ""
+ "name" : "showDownload",
+ "type" : "Boolean",
+ "desc" : "e) show download button (default true)",
+ "memberOf" : "Roo.bootstrap.DocumentViewer"
},
{
- "name" : "sticky",
- "type" : "String",
- "desc" : "h) block to use as footer or body- needs css-bootstrap/sticky-footer.css",
- "memberOf" : ""
+ "name" : "showTrash",
+ "type" : "Boolean",
+ "desc" : "e) show trash button (default true)",
+ "memberOf" : "Roo.bootstrap.DocumentViewer"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "n) type of HTML tag.",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "well",
- "type" : "String",
- "desc" : "d) a well, large, small or medium.",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
{
"name" : "click",
"type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fire after click",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Container",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.bootstrap.DocumentViewer",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "destroy",
"type" : "function",
- "desc" : "After the panel has been collapsed",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Container",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "download",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fire after download button",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.DocumentViewer",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "expand",
+ "name" : "hide",
"type" : "function",
- "desc" : "After the panel has been expand",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Container",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "initial",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fire after initEvent",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.DocumentViewer",
"desc" : "",
"isOptional" : false
}
}
],
"returns" : []
+ },
+ {
+ "name" : "trash",
+ "type" : "function",
+ "desc" : "Fire after trash button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.DocumentViewer",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.DateField" : {
+ "Roo.bootstrap.DropTarget" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "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" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "clickable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "container_method",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "daysOfWeekDisabled",
- "type" : "Object",
- "desc" : "default empty",
- "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" : "endDate",
- "type" : "Number",
- "desc" : "default Infinity",
- "memberOf" : ""
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "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" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "keyboardNavigation",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "language",
+ "name" : "html",
"type" : "String",
- "desc" : "default en",
- "memberOf" : ""
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "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" : "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" : "minViewMode",
- "type" : "String",
- "desc" : "default empty, (months|years)",
- "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" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "dropable name",
+ "memberOf" : "Roo.bootstrap.DropTarget"
},
{
- "name" : "readOnly",
+ "name" : "preventDefault",
"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" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
- "name" : "regexText",
+ "name" : "role",
"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"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "startDate",
- "type" : "Number",
- "desc" : "default -Infinity",
- "memberOf" : ""
+ "desc" : "default blank - set to button to force cursor pointer",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "todayBtn",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
- },
- {
- "name" : "todayHighlight",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "tag of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "tooltip",
"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" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "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" : [
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires when before select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
"returns" : []
},
{
- "name" : "blur",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "click",
"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" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.Element",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.DateSplitField" : {
+ "Roo.bootstrap.Element" : {
"props" : [
{
"name" : "actionMode",
"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"
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "container_method",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "dayAllowBlank",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
- {
- "name" : "dayFormat",
- "type" : "string",
- "desc" : "default 'd'",
- "memberOf" : ""
- },
- {
- "name" : "dayPlaceholder",
- "type" : "string",
- "desc" : "",
- "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" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "labelAlign",
+ "name" : "html",
"type" : "String",
- "desc" : "t)",
- "memberOf" : ""
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label (0-12)",
- "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" : ""
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "monthAllowBlank",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
- {
- "name" : "monthFormat",
+ "name" : "name",
"type" : "string",
- "desc" : "default 'm'",
- "memberOf" : ""
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "monthPlaceholder",
- "type" : "string",
- "desc" : "",
- "memberOf" : ""
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "role",
+ "type" : "String",
+ "desc" : "default blank - set to button to force cursor pointer",
+ "memberOf" : "Roo.bootstrap.Element"
},
{
"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",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "yearAllowBlank",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
- {
- "name" : "yearFormat",
- "type" : "string",
- "desc" : "default 'Y'",
- "memberOf" : ""
- },
- {
- "name" : "yearPlaceholder",
- "type" : "string",
- "desc" : "",
- "memberOf" : ""
}
],
"events" : [
"returns" : []
},
{
- "name" : "days",
+ "name" : "click",
"type" : "function",
- "desc" : "getting the data of days",
- "sig" : "function (_self, days)\n{\n\n}",
+ "desc" : "When a element is chick",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.DateSplitField",
+ "type" : "Roo.bootstrap.Element",
"desc" : "",
"isOptional" : false
},
{
- "name" : "days",
- "type" : "Object",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "years",
- "type" : "function",
- "desc" : "getting the data of years",
- "sig" : "function (_self, years)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DateSplitField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "years",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.Element" : [
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.DropTarget"
+ ]
+ },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.DocumentManager" : {
+ "Roo.bootstrap.Graph" : {
"props" : [
{
"name" : "actionMode",
"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" : "editable",
- "type" : "Boolean",
- "desc" : "e) allow edit when upload a image default true",
- "memberOf" : ""
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "name" : "g_height",
+ "type" : "number",
+ "desc" : "height of the chart (respected by all elements in the set)",
+ "memberOf" : "Roo.bootstrap.Graph"
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "p) default left",
- "memberOf" : ""
+ "name" : "g_r",
+ "type" : "number",
+ "desc" : "radius (pie)",
+ "memberOf" : "Roo.bootstrap.Graph"
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "default 4",
- "memberOf" : ""
+ "name" : "g_width",
+ "type" : "number",
+ "desc" : "width of the chart (respected by all elements in the set)",
+ "memberOf" : "Roo.bootstrap.Graph"
},
{
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "name" : "g_x",
+ "type" : "number",
+ "desc" : "coodinator | centre x (pie)",
+ "memberOf" : "Roo.bootstrap.Graph"
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "name" : "g_y",
+ "type" : "number",
+ "desc" : "coodinator | centre y (pie)",
+ "memberOf" : "Roo.bootstrap.Graph"
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "name" : "graphtype",
+ "type" : "String",
+ "desc" : "bar | vbar | pie",
+ "memberOf" : "Roo.bootstrap.Graph"
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
"name" : "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" : "thumbSize",
- "type" : "Number",
- "desc" : "default 300",
- "memberOf" : ""
- },
- {
- "name" : "toolTipName",
- "type" : "String",
- "desc" : "default 'filename'",
- "memberOf" : ""
+ "name" : "title",
+ "type" : "Object",
+ "desc" : "The title of the chart\n \n -{Array} values\n -opts (object) options for the chart \n o {\n o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n o vgutter (number)\n o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n o stacked (boolean) whether or not to tread values as in a stacked bar chart\n o to\n o stretch (boolean)\n o }\n -opts (object) options for the pie\n o{\n o cut\n o startAngle (number)\n o endAngle (number)\n }",
+ "memberOf" : "Roo.bootstrap.Graph"
},
{
"name" : "tooltip",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "url",
- "type" : "String",
- "desc" : "action url",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
}
],
"events" : [
- {
- "name" : "afterupload",
- "type" : "function",
- "desc" : "Fire when xhr load exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "xhr",
- "type" : "XMLHttpRequest",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselectfile",
- "type" : "function",
- "desc" : "Fire before select file",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
{
"name" : "click",
"type" : "function",
- "desc" : "Fire after click the image",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fire when upload a image and editable set to true",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "exception",
- "type" : "function",
- "desc" : "Fire when xhr load exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "xhr",
- "type" : "XMLHttpRequest",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initial",
- "type" : "function",
- "desc" : "Fire when initial the DocumentManager",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "inspect",
- "type" : "function",
- "desc" : "inspect selected file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "File",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "prepare",
- "type" : "function",
- "desc" : "prepare the form data",
- "sig" : "function (_self, formData)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "formData",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "previewrendered",
- "type" : "function",
- "desc" : "Fire when preview rendered",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "process",
- "type" : "function",
- "desc" : "Fire before process file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Fire after refresh the file",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fire when remove the file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentManager",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.DocumentSlider" : {
+ "Roo.bootstrap.Header" : {
"props" : [
{
"name" : "actionMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of header",
+ "memberOf" : "Roo.bootstrap.Header"
+ },
+ {
+ "name" : "level",
+ "type" : "Number",
+ "desc" : "6) default 1",
+ "memberOf" : "Roo.bootstrap.Header"
+ },
{
"name" : "listeners",
"type" : "Object",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fire after click",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentSlider",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initial",
- "type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentSlider",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "update",
- "type" : "function",
- "desc" : "Fire after update",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentSlider",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.DocumentViewer" : {
+ "Roo.bootstrap.Img" : {
"props" : [
{
"name" : "actionMode",
"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" : "Roo.bootstrap.Img"
+ },
+ {
+ "name" : "backgroundContain",
+ "type" : "Boolean",
+ "desc" : "(use style background and contain image in content)",
+ "memberOf" : "Roo.bootstrap.Img"
+ },
+ {
+ "name" : "border",
+ "type" : "String",
+ "desc" : "rounded | circle | thumbnail",
+ "memberOf" : "Roo.bootstrap.Img"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "a tag href",
+ "memberOf" : "Roo.bootstrap.Img"
+ },
+ {
+ "name" : "imgResponsive",
+ "type" : "Boolean",
+ "desc" : "false | true",
+ "memberOf" : "Roo.bootstrap.Img"
+ },
+ {
+ "name" : "lgUrl",
+ "type" : "String",
+ "desc" : "lg image source",
+ "memberOf" : "Roo.bootstrap.Img"
+ },
{
"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" : "mdUrl",
+ "type" : "String",
+ "desc" : "md image source",
+ "memberOf" : "Roo.bootstrap.Img"
+ },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "showDownload",
- "type" : "Boolean",
- "desc" : "e) show download button (default true)",
- "memberOf" : ""
+ "name" : "smUrl",
+ "type" : "String",
+ "desc" : "sm image source",
+ "memberOf" : "Roo.bootstrap.Img"
},
{
- "name" : "showTrash",
- "type" : "Boolean",
- "desc" : "e) show trash button (default true)",
- "memberOf" : ""
+ "name" : "src",
+ "type" : "String",
+ "desc" : "image source",
+ "memberOf" : "Roo.bootstrap.Img"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "p)target for a href.",
+ "memberOf" : "Roo.bootstrap.Img"
+ },
{
"name" : "tooltip",
"type" : "string",
"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" : "Roo.bootstrap.Img"
}
],
"events" : [
{
"name" : "click",
"type" : "function",
- "desc" : "Fire after click",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentViewer",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "download",
- "type" : "function",
- "desc" : "Fire after download button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentViewer",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
"returns" : []
},
{
- "name" : "initial",
+ "name" : "load",
"type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "The when any image loads",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentViewer",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
}
],
"returns" : []
- },
- {
- "name" : "trash",
- "type" : "function",
- "desc" : "Fire after trash button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DocumentViewer",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "setSrc",
+ "type" : "function",
+ "desc" : "Sets the url of the image - used to update it",
+ "sig" : "(url)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "the url of the image",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.DropTarget" : {
+ "Roo.bootstrap.LayoutMasonry" : {
"props" : [
{
"name" : "actionMode",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "alternativePadWidth",
+ "type" : "Number",
+ "desc" : "padding below box..",
+ "memberOf" : "Roo.bootstrap.LayoutMasonry"
+ },
+ {
+ "name" : "boxHeight",
+ "type" : "Number",
+ "desc" : "- 0 for square, or fix it at a certian height",
+ "memberOf" : "Roo.bootstrap.LayoutMasonry"
+ },
+ {
+ "name" : "boxWidth",
+ "type" : "Number",
+ "desc" : "width of the columns",
+ "memberOf" : "Roo.bootstrap.LayoutMasonry"
+ },
{
"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" : "Roo.bootstrap.Element"
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "gutter",
+ "type" : "Number",
+ "desc" : "gutter width..",
+ "memberOf" : "Roo.bootstrap.LayoutMasonry"
+ },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "contents of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "name" : "isAutoInitial",
+ "type" : "Boolean",
+ "desc" : "defalut true",
+ "memberOf" : "Roo.bootstrap.LayoutMasonry"
+ },
+ {
+ "name" : "isHorizontal",
+ "type" : "Boolean",
+ "desc" : "defalut false",
+ "memberOf" : "Roo.bootstrap.LayoutMasonry"
+ },
+ {
+ "name" : "isLayoutInstant",
+ "type" : "Boolean",
+ "desc" : "= no animation?",
+ "memberOf" : "Roo.bootstrap.LayoutMasonry"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "dropable name",
- "memberOf" : ""
+ "name" : "maxCols",
+ "type" : "Number",
+ "desc" : "maximum number of columns",
+ "memberOf" : "Roo.bootstrap.LayoutMasonry"
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Element"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "role",
- "type" : "String",
- "desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "Roo.bootstrap.Element"
+ "name" : "padWidth",
+ "type" : "Number",
+ "desc" : "padding below box..",
+ "memberOf" : "Roo.bootstrap.LayoutMasonry"
},
{
"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",
"returns" : []
},
{
- "name" : "click",
+ "name" : "destroy",
"type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fire after layout the items",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.LayoutMasonry",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
}
],
"methods" : [
+ {
+ "name" : "_processVerticalLayoutQueue",
+ "type" : "function",
+ "desc" : "Sets position of item in DOM",
+ "sig" : "(item, x, y, isInstant)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "item",
+ "type" : "Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "- horizontal position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "- vertical position",
+ "isOptional" : false
+ },
+ {
+ "name" : "isInstant",
+ "type" : "Boolean",
+ "desc" : "- disables transitions",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addBrick",
+ "type" : "function",
+ "desc" : "adds a Masonry Brick",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "masonry brick to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearAll",
+ "type" : "function",
+ "desc" : "clear all the Masonry Brick",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a Masonry Layout based on the masonry layout ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "masonry layout to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Masonry Brick",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "masonry brick to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Masonry Layout",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.LayoutMasonry",
+ "desc" : "masonry layout to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "removeBrick",
+ "type" : "function",
+ "desc" : "remove a Masonry Brick",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "masonry brick to remove",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "removeListener",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.MasonryBrick"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.Element" : {
+ "Roo.bootstrap.LayoutMasonryAuto" : {
"props" : [
{
"name" : "actionMode",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "clickable",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "columnWidth",
+ "type" : "Number",
+ "desc" : "width of the columns",
+ "memberOf" : "Roo.bootstrap.LayoutMasonryAuto"
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "contents of the element",
- "memberOf" : ""
+ "name" : "isAutoInitial",
+ "type" : "Boolean",
+ "desc" : "defalut true",
+ "memberOf" : "Roo.bootstrap.LayoutMasonryAuto"
+ },
+ {
+ "name" : "isFitWidth",
+ "type" : "Boolean",
+ "desc" : "- resize the width..",
+ "memberOf" : "Roo.bootstrap.LayoutMasonryAuto"
+ },
+ {
+ "name" : "isLayoutInstant",
+ "type" : "Boolean",
+ "desc" : "= no animation?",
+ "memberOf" : "Roo.bootstrap.LayoutMasonryAuto"
+ },
+ {
+ "name" : "isOriginLeft",
+ "type" : "Boolean",
+ "desc" : "= left align?",
+ "memberOf" : "Roo.bootstrap.LayoutMasonryAuto"
+ },
+ {
+ "name" : "isOriginTop",
+ "type" : "Boolean",
+ "desc" : "= top align?",
+ "memberOf" : "Roo.bootstrap.LayoutMasonryAuto"
+ },
+ {
+ "name" : "isResizingContainer",
+ "type" : "Boolean",
+ "desc" : "= not sure if this is used..",
+ "memberOf" : "Roo.bootstrap.LayoutMasonryAuto"
},
{
"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" : "Roo.bootstrap.LayoutMasonryAuto"
+ },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
- {
- "name" : "role",
- "type" : "String",
- "desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : ""
+ "name" : "padHeight",
+ "type" : "Number",
+ "desc" : "padding below box..",
+ "memberOf" : "Roo.bootstrap.LayoutMasonryAuto"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "tag of the element",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "When a element is chick",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
],
"methods" : [
+ {
+ "name" : "_getColGroup",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "(colSpan)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "colSpan",
+ "type" : "Number",
+ "desc" : "- number of columns the element spans",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "_processLayoutQueue",
+ "type" : "function",
+ "desc" : "Sets position of item in DOM",
+ "sig" : "(item, x, y, isInstant)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "item",
+ "type" : "Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "- horizontal position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "- vertical position",
+ "isOptional" : false
+ },
+ {
+ "name" : "isInstant",
+ "type" : "Boolean",
+ "desc" : "- disables transitions",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.FieldLabel" : {
+ "Roo.bootstrap.Link" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "e) target allowBlank default true",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"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" : "Roo.bootstrap.Link"
+ },
+ {
+ "name" : "anchor",
+ "type" : "String",
+ "desc" : "name for the anchor link",
+ "memberOf" : "Roo.bootstrap.Link"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "cls",
"type" : "String",
- "desc" : "class of the element",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "html",
+ "name" : "fa",
"type" : "String",
- "desc" : "contents of the element",
- "memberOf" : ""
+ "desc" : "- favicon",
+ "memberOf" : "Roo.bootstrap.Link"
},
{
- "name" : "iconTooltip",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "default \"This field is required\"",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "indicatorpos",
+ "name" : "href",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : ""
+ "desc" : "a tag href",
+ "memberOf" : "Roo.bootstrap.Link"
},
{
- "name" : "invalidClass",
+ "name" : "html",
"type" : "String",
- "desc" : "DEPRICATED - BS4 uses is-invalid",
- "memberOf" : ""
+ "desc" : "the content of the link.",
+ "memberOf" : "Roo.bootstrap.Link"
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Link"
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "tag of the element default label",
- "memberOf" : ""
- },
{
"name" : "target",
"type" : "String",
- "desc" : "label target",
- "memberOf" : ""
+ "desc" : "p) target for a href.",
+ "memberOf" : "Roo.bootstrap.Link"
},
{
"name" : "tooltip",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - BS4 uses is-valid",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.FieldLabel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
}
],
"returns" : []
}
],
"returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.FieldLabel",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a FieldLabel Group based on the target",
- "sig" : "(target)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "string",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a FieldLabel Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.FieldLabel",
- "desc" : "FieldLabel to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.Form" : {
+ "Roo.bootstrap.LocationPicker" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "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",
"memberOf" : "Roo.Component"
},
{
- "name" : "errorMask",
+ "name" : "disableDoubleClickZoom",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "default false",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
},
{
- "name" : "fileUpload",
+ "name" : "draggable",
"type" : "Boolean",
- "desc" : "Set to true if this form is a file upload.",
- "memberOf" : ""
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
+ },
+ {
+ "name" : "enableAutocomplete",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
+ },
+ {
+ "name" : "enableReverseGeocode",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "top | left (default top)",
- "memberOf" : ""
+ "name" : "latitude",
+ "type" : "Number",
+ "desc" : "Position when init default 0",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "load mask when submit (default true)",
- "memberOf" : ""
+ "name" : "locationName",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
},
{
- "name" : "maskBody",
+ "name" : "longitude",
+ "type" : "Number",
+ "desc" : "Position when init default 0",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
+ },
+ {
+ "name" : "mapTypeControl",
"type" : "Boolean",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "default false",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
},
{
- "name" : "maskOffset",
- "type" : "Number",
- "desc" : "Default 100",
- "memberOf" : ""
+ "name" : "mapTypeId",
+ "type" : "String",
+ "desc" : "default google.maps.MapTypeId.ROADMAP",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
},
{
- "name" : "method",
+ "name" : "markerTitle",
"type" : "String",
- "desc" : "GET | POST (default POST)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
},
{
"name" : "name",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "radius",
+ "type" : "Number",
+ "desc" : "default 0",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
+ },
+ {
+ "name" : "scrollwheel",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
+ },
+ {
+ "name" : "streetViewControl",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "Roo.bootstrap.LocationPicker"
+ },
{
"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",
"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" : "Roo.bootstrap.LocationPicker"
}
],
"events" : [
{
- "name" : "actioncomplete",
+ "name" : "OverlayViewDraw",
"type" : "function",
- "desc" : "Fires when an action is completed.",
- "sig" : "function (_self, action)\n{\n\n}",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "OverlayViewHide",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that completed",
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "actionfailed",
+ "name" : "OverlayViewOnAdd",
"type" : "function",
- "desc" : "Fires when an action fails.",
- "sig" : "function (_self, action)\n{\n\n}",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "OverlayViewOnRemove",
+ "type" : "function",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that failed",
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeaction",
+ "name" : "OverlayViewShow",
"type" : "function",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "sig" : "function (_self, action)\n{\n\n}",
+ "desc" : "Fires when OverlayView Draw",
+ "sig" : "function (_self, cpx)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
},
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action to be performed",
+ "name" : "cpx",
+ "type" : "Pixel",
+ "desc" : "",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "clientvalidation",
- "type" : "function",
- "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
- "sig" : "function (_self, valid)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Form",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "valid",
- "type" : "Boolean",
- "desc" : "true if the form has passed client-side validation",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"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" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "initial",
+ "type" : "function",
+ "desc" : "Fires when the picker initialized.",
+ "sig" : "function (_self, location)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "location",
+ "type" : "Google Location",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "loadexception",
+ "type" : "function",
+ "desc" : "Fires when load google lib failed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mapClick",
+ "type" : "function",
+ "desc" : "Fires when click the map.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Map event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mapRightClick",
+ "type" : "function",
+ "desc" : "Fires when right click the map.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Map event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markerClick",
+ "type" : "function",
+ "desc" : "Fires when click the marker.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Map event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markerRightClick",
+ "type" : "function",
+ "desc" : "Fires when right click the marker.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Map event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "positionchanged",
+ "type" : "function",
+ "desc" : "Fires when the picker position changed.",
+ "sig" : "function (_self, location)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "location",
+ "type" : "Google Location",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires when the map resize.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.LocationPicker",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"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" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.LocationPicker",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clears all invalid messages in this form.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doAction",
- "type" : "function",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
- "sig" : "(actionName, options)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "actionName",
- "type" : "String",
- "desc" : "The name of the action type",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "findField",
- "type" : "function",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The value to search for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Field"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "getFieldValues",
- "type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : ""
- }
- ]
- },
{
"name" : "getId",
"type" : "function",
}
]
},
- {
- "name" : "getValues",
- "type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
- "sig" : "(asString)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "asString",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : ""
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if any fields in this form have changed since their original load.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns true if client-side validation on the form is successful.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark fields in this form invalid in bulk.",
- "sig" : "(errors)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "errors",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets this form.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setValues",
- "type" : "function",
- "desc" : "Set values for fields in this form in bulk.",
- "sig" : "(values)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "values",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
- },
{
"name" : "setVisibilityEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Graph" : {
+ "Roo.bootstrap.MasonryBrick" : {
"props" : [
{
"name" : "actionMode",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "bgimage",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "g_height",
- "type" : "number",
- "desc" : "height of the chart (respected by all elements in the set)",
- "memberOf" : ""
- },
- {
- "name" : "g_r",
- "type" : "number",
- "desc" : "radius (pie)",
- "memberOf" : ""
- },
- {
- "name" : "g_width",
- "type" : "number",
- "desc" : "width of the chart (respected by all elements in the set)",
- "memberOf" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "g_x",
- "type" : "number",
- "desc" : "coodinator | centre x (pie)",
- "memberOf" : ""
+ "name" : "href",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
},
{
- "name" : "g_y",
- "type" : "number",
- "desc" : "coodinator | centre y (pie)",
- "memberOf" : ""
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
},
{
- "name" : "graphtype",
- "type" : "String",
- "desc" : "bar | vbar | pie",
- "memberOf" : ""
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "defalut false",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "name" : "isFitContainer",
+ "type" : "Boolean",
+ "desc" : "defalut true",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "placetitle",
+ "type" : "String",
+ "desc" : "m)",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
+ },
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "defalut false",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
+ },
+ {
+ "name" : "size",
+ "type" : "String",
+ "desc" : "e)",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
+ },
{
"name" : "style",
"type" : "String",
},
{
"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" : ""
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
},
{
"name" : "tooltip",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "videourl",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.MasonryBrick"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
{
"name" : "click",
"type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "When a MasonryBrick is clcik",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "e",
"type" : "Roo.EventObject",
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a masonry brick based on the masonry brick ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "masonry brick to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Masonry Brick",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.MasonryBrick",
+ "desc" : "masonry brick to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Header" : {
+ "Roo.bootstrap.MessageBar" : {
"props" : [
{
"name" : "actionMode",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "beforeClass",
+ "type" : "String",
+ "desc" : "insert the bar before the given class",
+ "memberOf" : "Roo.bootstrap.MessageBar"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.MessageBar"
+ },
{
"name" : "cls",
"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" : "Roo.bootstrap.MessageBar"
+ },
{
"name" : "hideMode",
"type" : "String",
{
"name" : "html",
"type" : "String",
- "desc" : "content of header",
- "memberOf" : ""
- },
- {
- "name" : "level",
- "type" : "Number",
- "desc" : "6) default 1",
- "memberOf" : ""
+ "desc" : "contents of the MessageBar",
+ "memberOf" : "Roo.bootstrap.MessageBar"
},
{
"name" : "listeners",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "r) default info",
+ "memberOf" : "Roo.bootstrap.MessageBar"
+ },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.HtmlEditor" : {
- "props" : [
+ "Roo.bootstrap.MessageBox" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "alert",
+ "type" : "function",
+ "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
},
{
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
},
{
- "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" : "getDialog",
+ "type" : "function",
+ "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BasicDialog",
+ "desc" : "The BasicDialog element"
+ }
+ ]
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides the message box if it is displayed",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if the message box is currently displayed",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the message box is visible, else false"
+ }
+ ]
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "progress",
+ "type" : "function",
+ "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
+ "sig" : "(title, msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "prompt",
+ "type" : "function",
+ "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
+ "sig" : "(title, msg, fn, scope, multiline)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ },
+ {
+ "name" : "multiline",
+ "type" : "Boolean/Number",
+ "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "updateProgress",
+ "type" : "function",
+ "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
+ "sig" : "(value, text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Number",
+ "desc" : "Any number between 0 and 1 (e.g., .5)",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "updateText",
+ "type" : "function",
+ "desc" : "Updates the message box body text",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "wait",
+ "type" : "function",
+ "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
+ "sig" : "(msg, title)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title bar text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.Modal" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "allow_close",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
- "name" : "blankText",
+ "name" : "bodyOverflow",
+ "type" : "Boolean",
+ "desc" : "should the body element have overflow auto added default false",
+ "memberOf" : "Roo.bootstrap.Modal"
+ },
+ {
+ "name" : "buttonPosition",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
- "name" : "buttons",
- "type" : "Array",
- "desc" : "Array of toolbar's buttons. - defaults to empty",
- "memberOf" : ""
+ "name" : "buttons[]",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "Array of buttons or standard button set..",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "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" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
+ "name" : "editableTitle",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "can the title be edited",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
- "name" : "hasFeedback",
+ "name" : "fitwindow",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "default false",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
"name" : "height",
"type" : "Number",
- "desc" : "(in pixels)",
- "memberOf" : ""
+ "desc" : "fixed height - usefull for chrome extension only really.",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
"name" : "hideMode",
},
{
"name" : "html",
- "type" : "string",
- "desc" : "text",
- "memberOf" : "Roo.bootstrap.TextArea"
- },
- {
- "name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
"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",
+ "name" : "max_width",
"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"
+ "desc" : "set the max width of modal",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
"type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "resizable",
+ "name" : "size",
"type" : "String",
- "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
- },
- {
- "name" : "resize",
- "type" : "string",
- "desc" : "l)",
- "memberOf" : "Roo.bootstrap.TextArea"
- },
- {
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : "Roo.bootstrap.TextArea"
+ "desc" : "l) default empty",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
- "name" : "selectOnFocus",
+ "name" : "specificTitle",
"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" : "default false",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "stylesheets",
- "type" : "Array",
- "desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : ""
+ "name" : "title",
+ "type" : "String",
+ "desc" : "Title of dialog",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
- "name" : "toolbars",
- "type" : "Array",
- "desc" : "Array of toolbars. - defaults to just the Standard one",
- "memberOf" : ""
+ "name" : "tmpl",
+ "type" : "Roo.Template",
+ "desc" : "- a template with variables. to use it, add a handler in show:method adn",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
"name" : "tooltip",
"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" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "width",
"type" : "Number",
- "desc" : "(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"
+ "desc" : "fixed width - usefull for chrome extension only really.",
+ "memberOf" : "Roo.bootstrap.Modal"
},
{
"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" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autosave",
- "type" : "function",
- "desc" : "Auto save the htmlEditor value as a file into Events",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "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" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
"returns" : []
},
{
- "name" : "beforesync",
+ "name" : "btnclick",
"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}",
+ "desc" : "The raw btnclick event for the button",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "editmodechange",
- "type" : "function",
- "desc" : "Fires when the editor switches edit modes",
- "sig" : "function (_self, sourceEdit)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "sourceEdit",
- "type" : "Boolean",
- "desc" : "True if source edit, false if standard editing.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "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" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "firstfocus",
- "type" : "function",
- "desc" : "Fires when on first focus - needed by toolbars..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
"returns" : []
},
{
- "name" : "initialize",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when the editor is fully initialized (including the iframe)",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paste",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
+ "desc" : "Fire when dialog resize",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.Modal",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "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" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "savedpreview",
- "type" : "function",
- "desc" : "preview the saved version of htmlEditor",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "specialkey",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "sync",
+ "name" : "titlechanged",
"type" : "function",
- "desc" : "Fires when the textarea is updated with content from the editor iframe.",
- "sig" : "function (_self, html)\n{\n\n}",
+ "desc" : "Fire when the editable title has been changed",
+ "sig" : "function (_self, value)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.Modal",
"desc" : "",
"isOptional" : false
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "value",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "applyBody",
+ "type" : "function",
+ "desc" : "Set the body of the Dialog using the template",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Obj",
+ "desc" : "- apply this data to the template and replace the body contents.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "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" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "editor",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real textarea element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "reset",
+ "name" : "setBody",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
+ "desc" : "Set the body of the Dialog",
+ "sig" : "(str)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "str",
+ "type" : "String",
+ "desc" : "new Title",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Set the title of the Dialog",
+ "sig" : "(str)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "str",
+ "type" : "String",
+ "desc" : "new Title",
"isOptional" : false
}
],
"params" : [],
"returns" : []
},
- {
- "name" : "toggleSourceEdit",
- "type" : "function",
- "desc" : "Toggles the editor between standard and source edit mode.",
- "sig" : "(sourceEdit)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "sourceEdit",
- "type" : "Boolean",
- "desc" : "(optional) True for source edit, false for standard",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "tooltipEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : true,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "none"
]
},
- "Roo.bootstrap.Img" : {
+ "Roo.bootstrap.Pagination" : {
"props" : [
{
"name" : "actionMode",
"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" : "backgroundContain",
- "type" : "Boolean",
- "desc" : "(use style background and contain image in content)",
- "memberOf" : ""
- },
- {
- "name" : "border",
- "type" : "String",
- "desc" : "rounded | circle | thumbnail",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "a tag href",
- "memberOf" : ""
- },
- {
- "name" : "imgResponsive",
+ "name" : "inverse",
"type" : "Boolean",
- "desc" : "false | true",
- "memberOf" : ""
- },
- {
- "name" : "lgUrl",
- "type" : "String",
- "desc" : "lg image source",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Pagination"
},
{
"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" : "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",
+ "name" : "size",
"type" : "String",
- "desc" : "image source",
- "memberOf" : ""
+ "desc" : "l)",
+ "memberOf" : "Roo.bootstrap.Pagination"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "target",
- "type" : "String",
- "desc" : "p)target for a href.",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"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" : [
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "load",
- "type" : "function",
- "desc" : "The when any image loads",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setSrc",
- "type" : "function",
- "desc" : "Sets the url of the image - used to update it",
- "sig" : "(url)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "String",
- "desc" : "the url of the image",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Pagination"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.Input" : {
+ "Roo.bootstrap.PaginationItem" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : ""
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : ""
- },
{
"name" : "actionMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : ""
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : ""
- },
- {
- "name" : "allowBlank",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : ""
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.PaginationItem"
},
{
"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" : "a) use for file input only. (default empty)",
- "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" : "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" : ""
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
+ "desc" : "default false",
+ "memberOf" : "Roo.bootstrap.PaginationItem"
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "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",
+ "name" : "href",
"type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : ""
+ "desc" : "the link",
+ "memberOf" : "Roo.bootstrap.PaginationItem"
},
{
- "name" : "labelAlign",
+ "name" : "html",
"type" : "String",
- "desc" : "t)",
- "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",
- "memberOf" : ""
+ "desc" : "text",
+ "memberOf" : "Roo.bootstrap.PaginationItem"
},
{
"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" : ""
- },
- {
- "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" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "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" : ""
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : ""
+ "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" : ""
- },
- {
- "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" : ""
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.PaginationItem"
},
{
"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" : ""
- },
- {
- "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" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : ""
- },
{
"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" : [
"returns" : []
},
{
- "name" : "blur",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.LayoutMasonry" : {
+ "Roo.bootstrap.PagingToolbar" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"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" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "name" : "boxWidth",
- "type" : "Number",
- "desc" : "width of the columns",
- "memberOf" : ""
+ "name" : "buttons[]",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "Buttons for the toolbar",
+ "memberOf" : "Roo.bootstrap.PagingToolbar"
},
{
"name" : "can_build_overlaid",
"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" : "Roo.bootstrap.PagingToolbar"
+ },
{
"name" : "container_method",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "gutter",
- "type" : "Number",
- "desc" : "gutter width..",
- "memberOf" : ""
+ "name" : "displayInfo",
+ "type" : "Boolean",
+ "desc" : "True to display the displayMsg (defaults to false)",
+ "memberOf" : "Roo.bootstrap.PagingToolbar"
},
{
- "name" : "hideMode",
+ "name" : "displayMsg",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
+ "memberOf" : "Roo.bootstrap.PagingToolbar"
},
{
- "name" : "isAutoInitial",
- "type" : "Boolean",
- "desc" : "defalut true",
- "memberOf" : ""
+ "name" : "emptyMsg",
+ "type" : "String",
+ "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
+ "memberOf" : "Roo.bootstrap.PagingToolbar"
},
{
- "name" : "isHorizontal",
- "type" : "Boolean",
- "desc" : "defalut false",
- "memberOf" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "isLayoutInstant",
+ "name" : "inverse",
"type" : "Boolean",
- "desc" : "= no animation?",
- "memberOf" : ""
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "maxCols",
- "type" : "Number",
- "desc" : "maximum number of columns",
- "memberOf" : ""
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "name",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "padWidth",
+ "name" : "pageSize",
"type" : "Number",
- "desc" : "padding below box..",
- "memberOf" : ""
+ "desc" : "The number of records to display per page (defaults to 20)",
+ "memberOf" : "Roo.bootstrap.PagingToolbar"
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The underlying data store providing the paged data",
+ "memberOf" : "Roo.bootstrap.PagingToolbar"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "layout",
- "type" : "function",
- "desc" : "Fire after layout the items",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LayoutMasonry",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"methods" : [
- {
- "name" : "_processVerticalLayoutQueue",
- "type" : "function",
- "desc" : "Sets position of item in DOM",
- "sig" : "(item, x, y, isInstant)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "item",
- "type" : "Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "- horizontal position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "- vertical position",
- "isOptional" : false
- },
- {
- "name" : "isInstant",
- "type" : "Boolean",
- "desc" : "- disables transitions",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addBrick",
- "type" : "function",
- "desc" : "adds a Masonry Brick",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "masonry brick to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "bind",
+ "type" : "function",
+ "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to bind",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "clearAll",
+ "name" : "collapse",
"type" : "function",
- "desc" : "clear all the Masonry Brick",
+ "desc" : "Collapse the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "get",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "fetch a Masonry Layout based on the masonry layout ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "masonry layout to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [],
+ "returns" : [
{
"name" : "",
"type" : "Roo.Element",
"params" : [],
"returns" : []
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Masonry Brick",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "masonry brick to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Masonry Layout",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.LayoutMasonry",
- "desc" : "masonry layout to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "removeBrick",
- "type" : "function",
- "desc" : "remove a Masonry Brick",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "masonry brick to remove",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "removeListener",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "unbind",
+ "type" : "function",
+ "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
+ "sig" : "(store)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to unbind",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.LayoutMasonryAuto" : {
+ "Roo.bootstrap.Popover" : {
"props" : [
+ {
+ "name" : "(right|top|bottom|left|auto)",
+ "type" : "String|function",
+ "desc" : "placement how it is placed",
+ "memberOf" : "Roo.bootstrap.Popover"
+ },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "add",
+ "type" : "String|Boolean|Roo.Element",
+ "desc" : "click hander to trigger show over what element\n - if false and it has a 'parent' then it will be automatically added to that element\n - if string - Roo.get will be called",
+ "memberOf" : "Roo.bootstrap.Popover"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "columnWidth",
- "type" : "Number",
- "desc" : "width of the columns",
- "memberOf" : ""
- },
{
"name" : "container_method",
"type" : "string",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "delay",
+ "type" : "Number",
+ "desc" : "- delay before showing",
+ "memberOf" : "Roo.bootstrap.Popover"
+ },
{
"name" : "disableClass",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "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" : "html",
+ "type" : "String",
+ "desc" : "contents of the popover (or false to use children..)",
+ "memberOf" : "Roo.bootstrap.Popover"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "maxCols",
- "type" : "Number",
- "desc" : "maximum number of columns",
- "memberOf" : ""
+ "name" : "modal",
+ "type" : "Boolean",
+ "desc" : "- popovers that are modal will mask the screen, and must be closed with another event.",
+ "memberOf" : "Roo.bootstrap.Popover"
},
{
"name" : "name",
"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" : "String",
+ "desc" : "of popover (or false to hide)",
+ "memberOf" : "Roo.bootstrap.Popover"
+ },
{
"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" : "Roo.bootstrap.Popover"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "After the popover hide",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Popover",
"desc" : "",
"isOptional" : false
}
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "After the popover show",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Popover",
"desc" : "",
"isOptional" : false
}
}
],
"methods" : [
- {
- "name" : "_getColGroup",
- "type" : "function",
- "desc" : "",
- "sig" : "(colSpan)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "colSpan",
- "type" : "Number",
- "desc" : "- number of columns the element spans",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "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" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "_processLayoutQueue",
- "type" : "function",
- "desc" : "Sets position of item in DOM",
- "sig" : "(item, x, y, isInstant)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "item",
- "type" : "Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "- horizontal position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "- vertical position",
- "isOptional" : false
- },
- {
- "name" : "isInstant",
- "type" : "Boolean",
- "desc" : "- disables transitions",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setContent",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "body content",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "title",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
{
"name" : "show",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Show the popover",
+ "sig" : "(-, (left|right|top|bottom))",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "-",
+ "type" : "Roo.Element|string|Boolean",
+ "desc" : "element to align and point to. (set align to [ pos, offset ])",
+ "isOptional" : false
+ },
+ {
+ "name" : "(left|right|top|bottom)",
+ "type" : "string",
+ "desc" : "position",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
}
],
"returns" : []
+ },
+ {
+ "name" : "updatePosition",
+ "type" : "function",
+ "desc" : "fire this manually after loading a grid in the table for example",
+ "sig" : "((left|right|top|bottom), try)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "(left|right|top|bottom)",
+ "type" : "string",
+ "desc" : "where to try and put it (use false to use the last one)",
+ "isOptional" : false
+ },
+ {
+ "name" : "try",
+ "type" : "Boolean",
+ "desc" : "and move it if we cant get right position.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : true,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "none"
]
},
- "Roo.bootstrap.Link" : {
+ "Roo.bootstrap.PopoverNav" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "alt",
- "type" : "String",
- "desc" : "image alternative text",
- "memberOf" : ""
- },
- {
- "name" : "anchor",
- "type" : "String",
- "desc" : "name for the anchor link",
- "memberOf" : ""
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "can_build_overlaid",
"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",
"memberOf" : "Roo.Component"
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "a tag href",
- "memberOf" : ""
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "the content of the link.",
- "memberOf" : ""
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "target",
+ "name" : "tag",
"type" : "String",
- "desc" : "p) target for a href.",
- "memberOf" : ""
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "tooltip",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.Container"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.Popover"
]
},
- "Roo.bootstrap.LocationPicker" : {
+ "Roo.bootstrap.Progress" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "animated of the progress bar",
+ "memberOf" : "Roo.bootstrap.Progress"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "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" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "latitude",
- "type" : "Number",
- "desc" : "Position when init default 0",
- "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" : "locationName",
- "type" : "String",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "longitude",
- "type" : "Number",
- "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" : ""
- },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "radius",
- "type" : "Number",
- "desc" : "default 0",
- "memberOf" : ""
- },
- {
- "name" : "scrollwheel",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
- },
- {
- "name" : "streetViewControl",
+ "name" : "striped",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "striped of the progress bar",
+ "memberOf" : "Roo.bootstrap.Progress"
},
{
"name" : "style",
"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" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "OverlayViewHide",
- "type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "OverlayViewOnAdd",
- "type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "OverlayViewOnRemove",
- "type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "OverlayViewShow",
- "type" : "function",
- "desc" : "Fires when OverlayView Draw",
- "sig" : "function (_self, cpx)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cpx",
- "type" : "Pixel",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires when the map hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "initial",
- "type" : "function",
- "desc" : "Fires when the picker initialized.",
- "sig" : "function (_self, location)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "location",
- "type" : "Google Location",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "loadexception",
- "type" : "function",
- "desc" : "Fires when load google lib failed.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mapClick",
- "type" : "function",
- "desc" : "Fires when click the map.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Map event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mapRightClick",
- "type" : "function",
- "desc" : "Fires when right click the map.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Map event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markerClick",
- "type" : "function",
- "desc" : "Fires when click the marker.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Map event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markerRightClick",
- "type" : "function",
- "desc" : "Fires when right click the marker.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Map event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "positionchanged",
- "type" : "function",
- "desc" : "Fires when the picker position changed.",
- "sig" : "function (_self, location)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "location",
- "type" : "Google Location",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires when the map resize.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when the map show.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.LocationPicker",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.ProgressBar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.Markdown" : {
+ "Roo.bootstrap.ProgressBar" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"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" : "aria_valuemax",
+ "type" : "Number",
+ "desc" : "aria-value max",
+ "memberOf" : "Roo.bootstrap.ProgressBar"
},
{
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "aria_valuemin",
+ "type" : "Number",
+ "desc" : "aria-value min",
+ "memberOf" : "Roo.bootstrap.ProgressBar"
},
{
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "aria_valuenow",
+ "type" : "Number",
+ "desc" : "aria-value now",
+ "memberOf" : "Roo.bootstrap.ProgressBar"
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "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",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "content",
- "type" : "string",
- "desc" : "",
- "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" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
- "type" : "string",
- "desc" : "text",
- "memberOf" : "Roo.bootstrap.TextArea"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelAlign",
+ "name" : "label",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "label for the progress bar",
+ "memberOf" : "Roo.bootstrap.ProgressBar"
},
{
"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" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "regexText",
+ "name" : "panel",
"type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "resize",
- "type" : "string",
- "desc" : "l)",
- "memberOf" : "Roo.bootstrap.TextArea"
- },
- {
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : "Roo.bootstrap.TextArea"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : ")",
+ "memberOf" : "Roo.bootstrap.ProgressBar"
},
{
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "role",
+ "type" : "String",
+ "desc" : "role of the progress bar",
+ "memberOf" : "Roo.bootstrap.ProgressBar"
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "sr_only",
+ "type" : "String",
+ "desc" : "text",
+ "memberOf" : "Roo.bootstrap.ProgressBar"
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "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"
- },
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real textarea element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TextArea",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.MasonryBrick" : {
+ "Roo.bootstrap.Row" : {
"props" : [
{
"name" : "actionMode",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "bgimage",
- "type" : "String",
- "desc" : "",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
{
"name" : "cls",
"type" : "String",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "defalut false",
- "memberOf" : ""
- },
- {
- "name" : "isFitContainer",
- "type" : "Boolean",
- "desc" : "defalut true",
- "memberOf" : ""
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "placetitle",
- "type" : "String",
- "desc" : "m)",
- "memberOf" : ""
- },
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "defalut false",
- "memberOf" : ""
- },
- {
- "name" : "size",
- "type" : "String",
- "desc" : "e)",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "videourl",
- "type" : "String",
- "desc" : "",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "When a MasonryBrick is clcik",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a masonry brick based on the masonry brick ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "masonry brick to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Masonry Brick",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.MasonryBrick",
- "desc" : "masonry brick to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.Menu" : {
+ "Roo.bootstrap.Slider" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "default tl-bl? == below - how the menu should be aligned.",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "hidden",
- "type" : "bool",
- "desc" : "if the menu should be hidden when rendered.",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "hideTrigger",
- "type" : "bool",
- "desc" : "e) default false - hide the carret for trigger.",
- "memberOf" : ""
- },
- {
- "name" : "isLink",
- "type" : "bool",
- "desc" : "e) the menu has link disable auto expand and collaspe (default false)",
- "memberOf" : ""
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "registerMenu",
- "type" : "Boolean",
- "desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : ""
- },
- {
- "name" : "stopEvent",
- "type" : "bool",
- "desc" : "e) Stop event after trigger press (default true)",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : "u) type of menu",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before this menu is hidden (return false to block)",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before this menu is displayed (return false to block)",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, menuItem, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "itemclick",
- "type" : "function",
- "desc" : "Fires when a menu item contained in this menu is clicked",
- "sig" : "function (baseItem, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "baseItem",
- "type" : "Roo.menu.BaseItem",
- "desc" : "The BaseItem that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseout",
- "type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseover",
- "type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
}
],
"returns" : []
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after this menu is displayed",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this menu and optionally all parent menus",
- "sig" : "(deep)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
{
"name" : "show",
"type" : "function",
- "desc" : "Displays this menu relative to another element",
- "sig" : "(element, position, parentMenu)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to",
- "isOptional" : false
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
- "isOptional" : false
- },
- {
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "showAt",
- "type" : "function",
- "desc" : "Displays this menu at a specific xy position",
- "sig" : "(xyPosition, parentMenu)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "xyPosition",
- "type" : "Array",
- "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
- "isOptional" : false
- },
- {
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.MenuItem" : {
+ "Roo.bootstrap.SplitBar" : {
"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" : "used on sidebars to highlight active itesm",
- "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" : "fa",
- "type" : "String",
- "desc" : "favicon to show on left of menu item.",
- "memberOf" : ""
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
- "memberOf" : ""
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "the menu label",
- "memberOf" : ""
- },
- {
- "name" : "isContainer",
- "type" : "Boolean",
- "desc" : "is it a container - just returns a drop down item..",
- "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" : "menu",
- "type" : "Roo.bootsrap.Menu",
- "desc" : "the child menu.",
- "memberOf" : ""
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "do not trigger A href on clicks (default false).",
- "memberOf" : ""
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
+ "name" : "beforeresize",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires before the splitter is dragged",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.bootstrap.SplitBar",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "moved",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires when the splitter is moved",
+ "sig" : "function (_self, newSize)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.MenuItem",
+ "type" : "Roo.bootstrap.SplitBar",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "the new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.SplitBar",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "the new width or height",
"isOptional" : false
}
],
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Destroy this splitbar.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "fireEvent",
]
},
{
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
+ "name" : "getAdapter",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Get the adapter this SplitBar uses",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "",
+ "desc" : "The adapter object"
}
]
},
{
- "name" : "getEl",
+ "name" : "getMaximumSize",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Gets the maximum size for the resizing element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Number",
+ "desc" : "The maximum size"
}
]
},
{
- "name" : "getId",
+ "name" : "getMinimumSize",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Gets the minimum size for the resizing element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Number",
+ "desc" : "The minimum size"
}
]
},
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setAdapter",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Set the adapter this SplitBar uses",
+ "sig" : "(adapter)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "adapter",
+ "type" : "Object",
+ "desc" : "A SplitBar adapter object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setCurrentSize",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Sets the initialize size for the resizing element",
+ "sig" : "(size)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "size",
+ "type" : "Number",
+ "desc" : "The initial size",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "setMaximumSize",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the maximum size for the resizing element",
+ "sig" : "(maxSize)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "maxSize",
+ "type" : "Number",
+ "desc" : "The maximum size",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "setMinimumSize",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Sets the minimum size for the resizing element",
+ "sig" : "(minSize)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "minSize",
+ "type" : "Number",
+ "desc" : "The minimum size",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "un",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "tooltipEl",
+ "name" : "getElementSize",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "setElementSize",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size to set",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "A function to be invoked when resizing is complete",
"isOptional" : false
}
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.MenuMgr" : {
+ "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : {
"props" : [],
"events" : [],
"methods" : [
{
- "name" : "get",
+ "name" : "getElementSize",
"type" : "function",
- "desc" : "Returns a {@link Roo.menu.Menu} object",
- "sig" : "(menu)",
+ "desc" : "Called before drag operations to get the current size of the resizing element.",
+ "sig" : "(s)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "menu",
- "type" : "String/Object",
- "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hideAll",
+ "name" : "setElementSize",
"type" : "function",
- "desc" : "Hides all menus that are currently visible",
- "sig" : "()\n{\n\n}",
+ "desc" : "Called after drag operations to set the size of the resizing element.",
+ "sig" : "(s, newSize, onComplete)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Roo.bootstrap.SplitBar",
+ "desc" : "The SplitBar using this adapter",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "onComplete",
+ "type" : "Function",
+ "desc" : "A function to be invoked when resizing is complete",
+ "isOptional" : false
+ }
+ ],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : [
+ "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.MenuSeparator" : {
+ "Roo.bootstrap.TabGroup" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "alert",
+ "type" : "String",
+ "desc" : "r) type alert (changes background / border...)",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "autoslide",
+ "type" : "Boolean",
+ "desc" : "e) auto slide .. default false",
+ "memberOf" : "Roo.bootstrap.TabGroup"
+ },
+ {
+ "name" : "bullets",
+ "type" : "Boolean",
+ "desc" : "show bullets for the panels",
+ "memberOf" : "Roo.bootstrap.TabGroup"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "carousel",
+ "type" : "Boolean",
+ "desc" : "true to make the group behave like a carousel",
+ "memberOf" : "Roo.bootstrap.TabGroup"
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : ".) font awesome icon",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "fasize",
+ "type" : "Number",
+ "desc" : ".) font awsome size",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "e) hide the element",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of column.",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : ".) glyphicon name",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "lgoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
{
"name" : "listeners",
"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" : "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",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "navId",
+ "type" : "String",
+ "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
+ "memberOf" : "Roo.bootstrap.TabGroup"
+ },
+ {
+ "name" : "showarrow",
+ "type" : "Boolean",
+ "desc" : "e) show arrow default true",
+ "memberOf" : "Roo.bootstrap.TabGroup"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
+ {
+ "name" : "smoff",
+ "type" : "Number",
+ "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
+ "memberOf" : "Roo.bootstrap.Column"
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "timer",
+ "type" : "Number",
+ "desc" : "auto slide timer .. default 0 millisecond",
+ "memberOf" : "Roo.bootstrap.TabGroup"
+ },
{
"name" : "tooltip",
"type" : "string",
"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" : [
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "navgroup to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Group",
+ "desc" : "navgroup to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "show a specific panel",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Roo.bootstrap.TabPanel|number|string",
+ "desc" : "to change to (use the tabId to specify a specific one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "false if panel was not shown (invalid entry or beforedeactivate fails.)"
+ }
+ ]
+ },
{
"name" : "tooltipEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.TabPanel"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.MessageBar" : {
+ "Roo.bootstrap.TabPanel" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "panel active",
+ "memberOf" : "Roo.bootstrap.TabPanel"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "beforeClass",
- "type" : "String",
- "desc" : "insert the bar before the given class",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
"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" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "click to link..",
+ "memberOf" : "Roo.bootstrap.TabPanel"
+ },
{
"name" : "html",
"type" : "String",
- "desc" : "contents of the MessageBar",
- "memberOf" : ""
+ "desc" : "panel content",
+ "memberOf" : "Roo.bootstrap.TabPanel"
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "navId",
+ "type" : "String",
+ "desc" : "The Roo.bootstrap.nav.Group which triggers show hide ()",
+ "memberOf" : "Roo.bootstrap.TabPanel"
+ },
{
"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" : "Roo.bootstrap.TabPanel"
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "touchSlide",
+ "type" : "Boolean",
+ "desc" : "if swiping slides tab to next panel (default off)",
+ "memberOf" : "Roo.bootstrap.TabPanel"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "r) default info",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
}
],
"events" : [
+ {
+ "name" : "beforedeactivate",
+ "type" : "function",
+ "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.TabPanel",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "false if there is an error"
+ }
+ ]
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active status changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.TabPanel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "the new state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
}
- ]
- },
- "Roo.bootstrap.MessageBox" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "alert",
- "type" : "function",
- "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
- "sig" : "(title, msg, fn, scope)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "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" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "getDialog",
- "type" : "function",
- "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BasicDialog",
- "desc" : "The BasicDialog element"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides the message box if it is displayed",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if the message box is currently displayed",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the message box is visible, else false"
- }
- ]
- },
- {
- "name" : "progress",
- "type" : "function",
- "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
- "sig" : "(title, msg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "prompt",
- "type" : "function",
- "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
- "sig" : "(title, msg, fn, scope, multiline)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title bar text",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "(optional) The callback function invoked after the message box is closed",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the callback function",
- "isOptional" : false
- },
- {
- "name" : "multiline",
- "type" : "Boolean/Number",
- "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "Configuration options",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "updateProgress",
- "type" : "function",
- "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
- "sig" : "(value, text)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Number",
- "desc" : "Any number between 0 and 1 (e.g., .5)",
- "isOptional" : false
- },
- {
- "name" : "text",
- "type" : "String",
- "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "updateText",
- "type" : "function",
- "desc" : "Updates the message box body text",
- "sig" : "(text)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- },
- {
- "name" : "wait",
- "type" : "function",
- "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
- "sig" : "(msg, title)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The message box body text",
- "isOptional" : false
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title bar text",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.MessageBox",
- "desc" : "This message box"
- }
- ]
- }
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.Modal" : {
+ "Roo.bootstrap.Table" : {
"props" : [
{
"name" : "actionMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "allow_close",
+ "name" : "auto_hide_footer",
"type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
+ "desc" : "auto hide footer if only one page (default false)",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : ""
+ "name" : "bordered",
+ "type" : "boolean",
+ "desc" : "Add borders to the table",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "bodyOverflow",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "should the body element have overflow auto added default false",
- "memberOf" : ""
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "buttonPosition",
- "type" : "String",
- "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left",
- "memberOf" : ""
+ "name" : "cellSelection",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "buttons",
- "type" : "Array",
- "desc" : "Array of buttons or standard button set..",
- "memberOf" : ""
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "table class",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "A column for the grid.",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "condensed",
+ "type" : "boolean",
+ "desc" : "Format condensed",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "editableTitle",
+ "name" : "enableColumnResize",
"type" : "Boolean",
- "desc" : "can the title be edited",
- "memberOf" : ""
+ "desc" : "default true if columns can be resized (drag/drop)",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "fitwindow",
+ "name" : "footer",
+ "type" : "Roo.bootstrap.PagingToolbar",
+ "desc" : "a paging toolbar",
+ "memberOf" : "Roo.bootstrap.Table"
+ },
+ {
+ "name" : "footerShow",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "e) generate tfoot, default true",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "fixed height - usefull for chrome extension only really.",
- "memberOf" : ""
+ "name" : "headerShow",
+ "type" : "Boolean",
+ "desc" : "e) generate thead, default true",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
- "memberOf" : ""
+ "name" : "hover",
+ "type" : "boolean",
+ "desc" : "Add hover highlighting",
+ "memberOf" : "Roo.bootstrap.Table"
+ },
+ {
+ "name" : "lazyLoad",
+ "type" : "Boolean",
+ "desc" : "auto load data while scrolling to the end (default false)",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "max_width",
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Table"
+ },
+ {
+ "name" : "minColumnWidth",
"type" : "Number",
- "desc" : "set the max width of modal",
- "memberOf" : ""
+ "desc" : "default 50 pixels minimum column width",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
"name" : "name",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "size",
- "type" : "String",
- "desc" : "l) default empty",
- "memberOf" : ""
+ "name" : "responsive",
+ "type" : "boolean",
+ "desc" : "default false - if this is on, columns are rendered with col-xs-4 etc. classes, otherwise columns will be sized by CSS,\n also adds table-responsive (see bootstrap docs for details)",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "specificTitle",
+ "name" : "rowSelection",
"type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "scrollBody",
+ "type" : "Boolean",
+ "desc" : "e) default false - body scrolled / fixed header",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "Title of dialog",
- "memberOf" : ""
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection model to use (cell selection is not supported yet)",
+ "memberOf" : "Roo.bootstrap.Table"
},
{
- "name" : "tmpl",
- "type" : "Roo.Template",
- "desc" : "- a template with variables. to use it, add a handler in show:method adn",
- "memberOf" : ""
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to use",
+ "memberOf" : "Roo.bootstrap.Table"
+ },
+ {
+ "name" : "striped",
+ "type" : "boolean",
+ "desc" : "Should the rows be alternative striped",
+ "memberOf" : "Roo.bootstrap.Table"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "tooltip",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "fixed width - usefull for chrome extension only really.",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "btnclick",
+ "name" : "cellclick",
"type" : "function",
- "desc" : "The raw btnclick event for the button",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "cellcontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "celldblclick",
+ "type" : "function",
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "e",
"type" : "Roo.EventObject",
],
"returns" : []
},
+ {
+ "name" : "contextmenu",
+ "type" : "function",
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "headercontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "mousedown",
+ "type" : "function",
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseout",
+ "type" : "function",
+ "desc" : "Fires when a mouseout occur",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "Fires when a mouseover occur",
+ "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
"returns" : []
},
{
- "name" : "resize",
+ "name" : "rowclass",
"type" : "function",
- "desc" : "Fire when dialog resize",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (_self, rowcfg)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Modal",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex colIndex and rowClass - set rowClass to add a style.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowclick",
+ "type" : "function",
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
},
"returns" : []
},
{
- "name" : "show",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "titlechanged",
+ "name" : "rowdblclick",
"type" : "function",
- "desc" : "Fire when the editable title has been changed",
- "sig" : "function (_self, value)\n{\n\n}",
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Modal",
+ "type" : "Roo.bootstrap.Table",
"desc" : "",
"isOptional" : false
},
{
- "name" : "value",
+ "name" : "el",
+ "type" : "Roo.Element",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
"type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
+ },
+ {
+ "name" : "rowsrendered",
+ "type" : "function",
+ "desc" : "Fires when all the rows have been rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "applyBody",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Set the body of the Dialog using the template",
- "sig" : "(data)",
+ "desc" : "Forces a resize - used by panel.Grid",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "data",
- "type" : "Obj",
- "desc" : "- apply this data to the template and replace the body contents.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "capture",
],
"returns" : []
},
+ {
+ "name" : "clear",
+ "type" : "function",
+ "desc" : "Remove all rows",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "ensureVisible",
+ "type" : "function",
+ "desc" : "Scrolls the specified cell into view",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
+ {
+ "name" : "focusCell",
+ "type" : "function",
+ "desc" : "Focuses the specified cell.",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focusRow",
+ "type" : "function",
+ "desc" : "Focuses the specified row.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getCellIndex",
+ "type" : "function",
+ "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})",
+ "sig" : "(cell)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cell",
+ "type" : "domElement",
+ "desc" : "to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getGridEl",
+ "type" : "function",
+ "desc" : "Returns the grid's underlying element = used by panel.Grid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getHeaderIndex",
+ "type" : "function",
+ "desc" : "get the header TH element for columnIndex",
+ "sig" : "(columnIndex)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getId",
"type" : "function",
}
]
},
+ {
+ "name" : "getRowIndex",
+ "type" : "function",
+ "desc" : "get the Row Index from a dom element.",
+ "sig" : "(row)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Roo.Element",
+ "desc" : "The row to look for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setBody",
- "type" : "function",
- "desc" : "Set the body of the Dialog",
- "sig" : "(str)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "str",
- "type" : "String",
- "desc" : "new Title",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "setRowVisibility",
"type" : "function",
- "desc" : "Set the title of the Dialog",
- "sig" : "(str)",
+ "desc" : "Show or hide a row.",
+ "sig" : "(rowIndex, state)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "str",
- "type" : "String",
- "desc" : "new Title",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "to show or hide",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "hide",
"isOptional" : false
}
],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.TableBody"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.MoneyField" : {
+ "Roo.bootstrap.TableBody" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "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" : ""
+ "desc" : "Aligns the content inside the element",
+ "memberOf" : "Roo.bootstrap.TableBody"
},
{
"name" : "allowDomMove",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "allowZero",
- "type" : "Boolean",
- "desc" : "False to blank out if the user enters '0' (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "append",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "autoFocus",
- "type" : "Boolean",
- "desc" : "e) auto focus the first item, default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "btnPosition",
- "type" : "String",
- "desc" : "set the position of the trigger button (left | right) default right",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "castInt",
- "type" : "Boolean",
- "desc" : "e) cast int if true (defalut true)",
- "memberOf" : ""
+ "name" : "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" : "Roo.bootstrap.TableBody"
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "element class",
+ "memberOf" : "Roo.bootstrap.TableBody"
},
{
"name" : "container_method",
"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" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "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",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "displayField",
+ "name" : "style",
"type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "emptyResultText",
- "type" : "Boolean",
- "desc" : "only for touch device",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "emptyTitle",
+ "name" : "tag",
"type" : "String",
- "desc" : "default ''",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "element tag (thead|tbody|tfoot) default tbody",
+ "memberOf" : "Roo.bootstrap.TableBody"
},
{
- "name" : "fieldLabel",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "focusClass",
+ "name" : "valign",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "desc" : "Vertical aligns the content inside the <tbody> element",
+ "memberOf" : "Roo.bootstrap.TableBody"
},
{
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.ComboBox"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "growMax",
- "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" : "growMin",
- "type" : "Number",
- "desc" : "",
- "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",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "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" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "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",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "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" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
- "memberOf" : ""
- },
- {
- "name" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
- },
- {
- "name" : "max_length",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
- "memberOf" : ""
- },
- {
- "name" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : ""
- },
- {
- "name" : "mobileTouchView",
- "type" : "Boolean",
- "desc" : "e) show mobile touch view when using a mobile default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "mobile_restrict_height",
- "type" : "Boolean",
- "desc" : "e) restrict height for touch view",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "modalTitle",
- "type" : "String",
- "desc" : "The title of the dialog that pops up on mobile views.",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "multiple",
- "type" : "Boolean",
- "desc" : "e) ComboBobArray, default false",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "nanText",
- "type" : "String",
- "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
- "memberOf" : ""
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "showToggleBtn",
- "type" : "Boolean",
- "desc" : "show toggle button or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "specialFilter",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "thousandsDelimiter",
- "type" : "String",
- "desc" : "Symbol of thousandsDelimiter",
- "memberOf" : ""
- },
- {
- "name" : "tickable",
- "type" : "Boolean",
- "desc" : "ComboBox with tickable selections (true|false), default false",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
- {
- "name" : "triggerList",
- "type" : "Boolean",
- "desc" : "trigger show the list or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "triggerText",
- "type" : "String",
- "desc" : "multiple combobox trigger button text default 'Select'",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "useNativeIOS",
- "type" : "Boolean",
- "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "fixed with? experimental",
- "memberOf" : "Roo.bootstrap.ComboBox"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- }
- ],
- "events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "afterremove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when the remove value from the combobox array",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialfilter",
- "type" : "function",
- "desc" : "Fires when specialfilter",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "tick",
- "type" : "function",
- "desc" : "Fires when tick the element",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "touchviewdisplay",
- "type" : "function",
- "desc" : "Fires when touch view require special display (default is using displayField)",
- "sig" : "function (combo, cfg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.bootstrap.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "set html .",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "value The selected value"
- }
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The value to match",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ]
- },
- "Roo.bootstrap.MonthField" : {
- "props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "autocomplete",
- "type" : "String",
- "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "language",
- "type" : "String",
- "desc" : "default en",
- "memberOf" : ""
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "size",
- "type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.MonthField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "oldvalue",
- "type" : "String",
- "desc" : "The old value",
- "isOptional" : false
- },
- {
- "name" : "newvalue",
- "type" : "String",
- "desc" : "The new value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.MonthField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addListener",
- "type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "on",
- "type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ]
- },
- "Roo.bootstrap.NavGroup" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : ""
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "navId",
- "type" : "String",
- "desc" : "- reference Id for navbar.",
- "memberOf" : ""
- },
- {
- "name" : "pilltype",
- "type" : "Boolean",
- "desc" : "default true (turn to off to disable active toggle)",
- "memberOf" : ""
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "b) default nav",
- "memberOf" : ""
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavGroup",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "selected",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The item selected",
- "isOptional" : false
- },
- {
- "name" : "prev",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The previously selected item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
"name" : "disable",
],
"returns" : []
},
- {
- "name" : "addItem",
- "type" : "function",
- "desc" : "adds a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "navitem to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addListener",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearAll",
- "type" : "function",
- "desc" : "clear all the Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getActive",
- "type" : "function",
- "desc" : "gets the active Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "the current navitem"
- }
- ]
- },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "navitem to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavGroup",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setActiveItem",
- "type" : "function",
- "desc" : "sets the active Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "new current navitem",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.TableRow"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.Table"
]
},
- "Roo.bootstrap.NavHeaderbar" : {
+ "Roo.bootstrap.TableCell" : {
"props" : [
+ {
+ "name" : "abbr",
+ "type" : "String",
+ "desc" : "Specifies an abbreviated version of the content in a cell",
+ "memberOf" : "Roo.bootstrap.TableCell"
+ },
{
"name" : "actionMode",
"type" : "String",
{
"name" : "align",
"type" : "String",
- "desc" : "t) alignment",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
+ "desc" : "Aligns the content in a cell",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
"name" : "allowDomMove",
"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",
+ "name" : "axis",
"type" : "String",
- "desc" : "what is brand",
- "memberOf" : ""
+ "desc" : "Categorizes cells",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
- "name" : "brand_href",
+ "name" : "bgcolor",
"type" : "String",
- "desc" : "href of the brand",
- "memberOf" : ""
+ "desc" : "Specifies the background color of a cell",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
"name" : "can_build_overlaid",
"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" : "Roo.bootstrap.TableCell"
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "cell class",
+ "memberOf" : "Roo.bootstrap.TableCell"
+ },
+ {
+ "name" : "colspan",
+ "type" : "Number",
+ "desc" : "Specifies the number of columns a cell should span",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
"name" : "container_method",
"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" : "headers",
+ "type" : "String",
+ "desc" : "Specifies one or more header cells a cell is related to",
+ "memberOf" : "Roo.bootstrap.TableCell"
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "Sets the height of a cell",
+ "memberOf" : "Roo.bootstrap.TableCell"
+ },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
+ "name" : "html",
+ "type" : "String",
+ "desc" : "cell contain text",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
"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"
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "mobilerow",
- "type" : "Roo.bootstrap.Row",
- "desc" : "- a row to display on mobile only..",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "position",
+ "name" : "nowrap",
"type" : "String",
- "desc" : "p) position",
- "memberOf" : ""
+ "desc" : "Specifies that the content inside a cell should not wrap",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
- "name" : "srButton",
- "type" : "Boolean",
- "desc" : "generate the (screen reader / mobile) sr-only button default true",
- "memberOf" : ""
+ "name" : "rowspan",
+ "type" : "Number",
+ "desc" : "Sets the number of rows a cell should span",
+ "memberOf" : "Roo.bootstrap.TableCell"
+ },
+ {
+ "name" : "scope",
+ "type" : "String",
+ "desc" : "Defines a way to associate header cells and data cells in a table",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
"name" : "style",
{
"name" : "tag",
"type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
+ "desc" : "cell tag (td|th) default td",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
"name" : "tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "type",
+ "name" : "valign",
"type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
+ "desc" : "Vertical aligns the content in a cell",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
"name" : "visibilityEl",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "Specifies the width of a cell",
+ "memberOf" : "Roo.bootstrap.TableCell"
},
{
"name" : "xattr",
],
"returns" : []
},
- {
- "name" : "beforetoggle",
- "type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.TableRow"
]
},
- "Roo.bootstrap.NavItem" : {
+ "Roo.bootstrap.TableRow" : {
"props" : [
{
"name" : "actionMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : ""
+ "name" : "align",
+ "type" : "String",
+ "desc" : "Aligns the content in a table row",
+ "memberOf" : "Roo.bootstrap.TableRow"
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "animateRef",
- "type" : "Boolean",
- "desc" : "e) link to element default false",
- "memberOf" : ""
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : ""
- },
- {
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the badge",
- "memberOf" : ""
- },
- {
- "name" : "button_outline",
- "type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : ""
- },
- {
- "name" : "button_weight",
+ "name" : "bgcolor",
"type" : "String",
- "desc" : "k) default none",
- "memberOf" : ""
+ "desc" : "Specifies a background color for a table row",
+ "memberOf" : "Roo.bootstrap.TableRow"
},
{
"name" : "can_build_overlaid",
"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" : "Roo.bootstrap.TableRow"
+ },
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "row class",
+ "memberOf" : "Roo.bootstrap.TableRow"
},
{
"name" : "container_method",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : ""
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : ""
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : ""
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of button",
- "memberOf" : ""
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : ""
- },
- {
- "name" : "linkcls",
- "type" : "String",
- "desc" : "Link Class",
- "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" : "menu",
- "type" : "Roo.bootstrap.Menu",
- "desc" : "a Menu",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tabId",
- "type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : ""
- },
- {
- "name" : "tagtype",
- "type" : "String",
- "desc" : "n) render as a href or span?",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "valign",
+ "type" : "String",
+ "desc" : "Vertical aligns the content in a table row",
+ "memberOf" : "Roo.bootstrap.TableRow"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
],
"returns" : []
},
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "scrollto",
- "type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setHtml",
- "type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "string",
- "desc" : "content for the nav item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.TableCell"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.TableBody"
]
},
- "Roo.bootstrap.NavProgressBar" : {
- "props" : [
+ "Roo.bootstrap.Tooltip" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "NavProgressBar:bullets[]",
- "type" : "Roo.bootstrap.NavProgressItem",
- "desc" : "Bullets for the Nav Progress bar for the toolbar",
- "memberOf" : ""
- },
+ "name" : "currentEl",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.UploadCropbox" : {
+ "props" : [
{
"name" : "actionMode",
"type" : "String",
"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" : "Roo.bootstrap.UploadCropbox"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "show when image has been loaded",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
+ {
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "isDocument",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
+ {
+ "name" : "loadingText",
+ "type" : "Boolean",
+ "desc" : "default 'Loading...'",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "default POST",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
+ {
+ "name" : "minHeight",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "paramName",
+ "type" : "String",
+ "desc" : "default 'imageUpload'",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
+ {
+ "name" : "rotateNotify",
+ "type" : "String",
+ "desc" : "show when image too small to rotate",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "action url",
+ "memberOf" : "Roo.bootstrap.UploadCropbox"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
}
],
"events" : [
+ {
+ "name" : "arrange",
+ "type" : "function",
+ "desc" : "Fire when arrange the file data",
+ "sig" : "function (_self, formData)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "formData",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforeloadcanvas",
"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" : "Fire before load the canvas",
+ "sig" : "function (_self, src)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "src",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "changed",
+ "name" : "beforeselectfile",
"type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.NavProgressBar",
+ "type" : "Roo.bootstrap.UploadCropbox",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "selected",
- "type" : "Roo.bootstrap.NavProgressItem",
- "desc" : "The item selected",
- "isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "prev",
- "type" : "Roo.bootstrap.NavProgressItem",
- "desc" : "The previously selected item",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "crop",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "download",
+ "type" : "function",
+ "desc" : "Fire when download the image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "exception",
+ "type" : "function",
+ "desc" : "Fire when get exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "footerbuttonclick",
+ "type" : "function",
+ "desc" : "Fire when footerbuttonclick",
+ "sig" : "function (_self, type)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initial",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "inspect",
+ "type" : "function",
+ "desc" : "Fire when inspect the file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "prepare",
+ "type" : "function",
+ "desc" : "Fire when preparing the file data",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fire when resize",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rotate",
+ "type" : "function",
+ "desc" : "Fire when rotate the image",
+ "sig" : "function (_self, pos)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "trash",
+ "type" : "function",
+ "desc" : "Fire when trash image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "upload",
+ "type" : "function",
+ "desc" : "Fire when xhr upload the file",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.NavProgressItem" : {
+ "Roo.bootstrap.breadcrumb" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.breadcrumb.Item" : {
"props" : [
{
"name" : "actionMode",
{
"name" : "active",
"type" : "Boolean",
- "desc" : "e) Is item active default false",
- "memberOf" : ""
+ "desc" : "is it active",
+ "memberOf" : "Roo.bootstrap.breadcrumb.Item"
},
{
"name" : "allowDomMove",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "e) Is item active default false",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
+ "name" : "href",
"type" : "String",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "where it links to if '#' is used the link will be handled by onClick.",
+ "memberOf" : "Roo.bootstrap.breadcrumb.Item"
},
{
- "name" : "icon",
+ "name" : "html",
"type" : "String",
- "desc" : "show icon instead of number",
- "memberOf" : ""
+ "desc" : "the content of the link.",
+ "memberOf" : "Roo.bootstrap.breadcrumb.Item"
},
{
"name" : "listeners",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "position",
- "type" : "String",
- "desc" : "m) text position default bottom",
- "memberOf" : ""
- },
- {
- "name" : "rid",
- "type" : "String",
- "desc" : "the reference id",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
{
"name" : "click",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "The img click event for the img.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavProgressItem",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Roo.EventObject",
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.breadcrumb.Nav"
]
},
- "Roo.bootstrap.NavSidebar" : {
+ "Roo.bootstrap.breadcrumb.Nav" : {
"props" : [
{
"name" : "actionMode",
],
"returns" : []
},
- {
- "name" : "beforetoggle",
- "type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.breadcrumb.Item"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.NavSidebarItem" : {
+ "Roo.bootstrap.dash" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.dash.NumberBox" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "animateRef",
- "type" : "Boolean",
- "desc" : "e) link to element default false",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the badge",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "button_outline",
- "type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "button_weight",
- "type" : "String",
- "desc" : "k) default none",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "content",
+ "type" : "String",
+ "desc" : "Box content",
+ "memberOf" : "Roo.bootstrap.dash.NumberBox"
+ },
{
"name" : "dataId",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "name" : "fhref",
+ "type" : "String",
+ "desc" : "Footer href",
+ "memberOf" : "Roo.bootstrap.dash.NumberBox"
},
{
- "name" : "fa",
+ "name" : "footer",
"type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "Footer text",
+ "memberOf" : "Roo.bootstrap.dash.NumberBox"
},
{
- "name" : "glyphicon",
+ "name" : "headline",
"type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "Box headline",
+ "memberOf" : "Roo.bootstrap.dash.NumberBox"
},
{
"name" : "hideMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of button",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "icon",
"type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "linkcls",
- "type" : "String",
- "desc" : "Link Class",
- "memberOf" : "Roo.bootstrap.NavItem"
+ "desc" : "Box icon",
+ "memberOf" : "Roo.bootstrap.dash.NumberBox"
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "menu",
- "type" : "Roo.bootstrap.Menu",
- "desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tabId",
- "type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
- {
- "name" : "tagtype",
- "type" : "String",
- "desc" : "n) render as a href or span?",
- "memberOf" : "Roo.bootstrap.NavItem"
- },
{
"name" : "tooltip",
"type" : "string",
],
"returns" : []
},
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavSidebarItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "scrollto",
- "type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.NavItem",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setHtml",
- "type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.NavItem",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "string",
- "desc" : "content for the nav item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.NavItem",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.NavSimplebar" : {
+ "Roo.bootstrap.dash.TabBox" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignment",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : ""
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "Icon of the TabBox",
+ "memberOf" : "Roo.bootstrap.dash.TabBox"
},
{
"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" : ""
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "showtabs",
+ "type" : "Boolean",
+ "desc" : "e) show the tabs default true",
+ "memberOf" : "Roo.bootstrap.dash.TabBox"
+ },
{
"name" : "style",
"type" : "String",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "tag",
+ "name" : "tabScrollable",
+ "type" : "Boolean",
+ "desc" : "e) tab scrollable when mobile view default false",
+ "memberOf" : "Roo.bootstrap.dash.TabBox"
+ },
+ {
+ "name" : "title",
"type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : ""
+ "desc" : "Title of the TabBox",
+ "memberOf" : "Roo.bootstrap.dash.TabBox"
},
{
"name" : "tooltip",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "type",
- "type" : "String",
- "desc" : "s)",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "activatepane",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "When a pane is activated",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "pane",
+ "type" : "Roo.bootstrap.dash.TabPane",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "addpane",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "When a pane is added",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "pane",
+ "type" : "Roo.bootstrap.dash.TabPane",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforetoggle",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Navbar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "Updates the box title",
+ "sig" : "(html)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to set the title to.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.dash.TabPane"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.Navbar" : {
+ "Roo.bootstrap.dash.TabPane" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.dash.TabPane"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "title of panel",
+ "memberOf" : "Roo.bootstrap.dash.TabPane"
+ },
{
"name" : "tooltip",
"type" : "string",
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "When a pane is activated",
+ "sig" : "function (pane)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "pane",
+ "type" : "Roo.bootstrap.dash.TabPane",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforetoggle",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\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",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setTitle",
+ "type" : "function",
+ "desc" : "Updates the tab title",
+ "sig" : "(html)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to set the title to.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup"
+ ],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.NumberField" : {
+ "Roo.bootstrap.form.CardUploader" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "allowDecimals",
- "type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "allowZero",
- "type" : "Boolean",
- "desc" : "False to blank out if the user enters '0' (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "autocomplete",
+ "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"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "text for badge",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "blankText",
+ "name" : "badge_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" : "k) default (same as button)",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
- },
- {
- "name" : "decimalSeparator",
- "type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "default false;",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
+ "memberOf" : "Roo.bootstrap.form.CardUploader"
},
{
- "name" : "focusClass",
+ "name" : "fa",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "depricated - use fa",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "hasFeedback",
+ "name" : "grpup",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelAlign",
+ "name" : "href",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "empty or href",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "html",
+ "type" : "Array",
+ "desc" : "The button text.",
+ "memberOf" : "Roo.bootstrap.form.CardUploader"
},
{
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "images",
+ "type" : "Array",
+ "desc" : "an array of ?? Img objects ??? when loading existing files..",
+ "memberOf" : "Roo.bootstrap.form.CardUploader"
},
{
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "dark themed version",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "isClose",
+ "type" : "Boolean",
+ "desc" : "default false;",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"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" : "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" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "nanText",
+ "name" : "offtext",
"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" : ""
+ "desc" : "text for off slidy toggle state",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "ontext",
+ "type" : "String",
+ "desc" : "text for on slidy toggle state",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "preventMark",
+ "name" : "outline",
"type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "readOnly",
+ "name" : "pressed",
"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" : "default null - if the button ahs active state",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "default true (stop click event triggering the URL if it's a link.)",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "selectOnFocus",
+ "name" : "removeClass",
"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" : "remove the standard class..",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"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"
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "thousandsDelimiter",
+ "name" : "tag",
"type" : "String",
- "desc" : "Symbol of thousandsDelimiter",
- "memberOf" : ""
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "validClass",
+ "name" : "target",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "r) target for a href.",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "validFeedbackIcon",
+ "name" : "theme",
"type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "w)",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "validateOnBlur",
+ "name" : "toggle",
"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" : "is it a slidy toggle button",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
- "name" : "value",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "valueAlign",
- "type" : "String",
- "desc" : "alignment of value",
- "memberOf" : ""
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "visibilityEl",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "vtype",
+ "name" : "weight",
"type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "k) default",
+ "memberOf" : "Roo.bootstrap.Button"
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
"returns" : []
},
{
- "name" : "blur",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "change",
+ "name" : "click",
"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" : "When a button is pressed",
+ "sig" : "function (btn, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "When a button is double clicked",
+ "sig" : "function (btn, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "download",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "When a the download link is clicked",
+ "sig" : "function (_self, The)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Card",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "The",
+ "type" : "Object",
+ "desc" : "image information data contains",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "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",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
+ "name" : "preview",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "When a image is clicked on - and needs to display a slideshow or similar..",
+ "sig" : "function (_self, The)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.bootstrap.Card",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "The",
+ "type" : "Object",
+ "desc" : "image information data",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "toggle",
"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" : "After the button has been toggles",
+ "sig" : "function (btn, e, pressed)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Button",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "btn",
+ "type" : "Roo.bootstrap.Button",
"desc" : "",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "The event object",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pressed",
+ "type" : "boolean",
+ "desc" : "(also available as button.pressed)",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "valid",
+ "name" : "addCard",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "addCard - add an Attachment to the uploader",
+ "sig" : "(data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "data",
+ "type" : "",
+ "desc" : "- the data about the image to upload\n\n{\n id : 123\n title : \"Title of file\",\n is_uploaded : false,\n src : \"http://.....\",\n srcfile : { the File upload object },\n mimetype : file.type,\n preview : false,\n is_deleted : 0\n .. any other data...\n }",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "disable",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Disable this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
+ "name" : "getText",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "get the text of the first selected button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
+ "returns" : []
},
{
"name" : "getVisibilityEl",
"returns" : []
},
{
- "name" : "inputEl",
+ "name" : "isActive",
"type" : "function",
- "desc" : "return the real input element.",
+ "desc" : "get the current active state",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if it's active"
+ }
+ ]
},
{
"name" : "isVisible",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "reset",
+ "name" : "setActive",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
+ "desc" : "sets the active state on/off,",
+ "sig" : "(state)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "(optional) Force a particular state",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
+ "name" : "setText",
"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" : "set the text of the first selected button",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Button",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"params" : [],
"returns" : []
},
+ {
+ "name" : "toggleActive",
+ "type" : "function",
+ "desc" : "toggles the current active state",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "tooltipEl",
"type" : "function",
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form.CheckBox" : {
+ "props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
+ "name" : "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" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ]
- },
- "Roo.bootstrap.Pagination" : {
- "props" : [
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "The text that appears beside the checkbox",
+ "memberOf" : "Roo.bootstrap.form.CheckBox"
+ },
+ {
+ "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.form.Input"
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "initnal the element",
+ "memberOf" : "Roo.bootstrap.form.CheckBox"
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "groupId",
+ "type" : "String",
+ "desc" : "the checkbox group id // normal just use for checkbox",
+ "memberOf" : "Roo.bootstrap.form.CheckBox"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inline",
+ "type" : "Boolean",
+ "desc" : "inline the element (default false)",
+ "memberOf" : "Roo.bootstrap.form.CheckBox"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputValue",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value when checked.",
+ "memberOf" : "Roo.bootstrap.form.CheckBox"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "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" : "cls",
+ "name" : "maskRe",
"type" : "String",
- "desc" : "css class",
- "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.form.Input"
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "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.form.Input"
},
{
- "name" : "disableClass",
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "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.bootstrap.form.Input"
},
{
- "name" : "hideMode",
+ "name" : "name",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "inverse",
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "preventMark",
"type" : "Boolean",
- "desc" : "false | true",
- "memberOf" : ""
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.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" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "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.form.Input"
},
{
- "name" : "size",
+ "name" : "regexText",
"type" : "String",
- "desc" : "xs | sm | md | lg",
- "memberOf" : ""
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "style",
},
{
"name" : "tooltip",
+ "type" : "String",
+ "desc" : "label tooltip",
+ "memberOf" : "Roo.bootstrap.form.CheckBox"
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
"type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "valueOff",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value when unchecked.",
+ "memberOf" : "Roo.bootstrap.form.CheckBox"
},
{
"name" : "visibilityEl",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "s) The text that appears beside the checkbox",
+ "memberOf" : "Roo.bootstrap.form.CheckBox"
+ },
{
"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.form.Input"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "check",
+ "type" : "function",
+ "desc" : "Fires when the element is checked or unchecked.",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.CheckBox",
+ "desc" : "This input",
+ "isOptional" : false
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "The new checked value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when the element is click.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.CheckBox",
+ "desc" : "This input",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a CheckBox Group based on the group ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "group ID",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getName",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Mixed",
+ "desc" : "name The name field"
}
]
},
{
- "name" : "hide",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
+ "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.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
},
{
- "name" : "initEvents",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "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.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "on",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "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",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "hide",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "render",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "inputEl",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "markValid",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
+ "desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
+ "returns" : []
},
{
- "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",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ]
- },
- "Roo.bootstrap.PaginationItem" : {
- "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" : "e) 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",
- "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" : "disabled",
- "type" : "Boolean",
- "desc" : "default false",
- "memberOf" : ""
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
- "memberOf" : ""
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "text",
- "memberOf" : ""
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "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" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default true",
- "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"
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "show",
+ "name" : "register",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "register a CheckBox Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "the",
+ "type" : "Roo.bootstrap.form.CheckBox",
+ "desc" : "CheckBox to add",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "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",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "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",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "render",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "reset",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "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.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "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.util.Observable",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
]
},
{
- "name" : "getChildContainer",
+ "name" : "show",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.bootstrap.Component",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getId",
+ "name" : "un",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
"type" : "String",
- "desc" : ""
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getVisibilityEl",
+ "name" : "validate",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
},
{
- "name" : "hasListener",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "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.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "True if the value is valid, else false"
}
]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form.ComboBox" : {
+ "props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "hide",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.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.form.ComboBox"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.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" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "autoFocus",
+ "type" : "Boolean",
+ "desc" : "e) auto focus the first item, default true",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "btnPosition",
+ "type" : "String",
+ "desc" : "set the position of the trigger button (left | right) default right",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
+ {
+ "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" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "displayField",
+ "type" : "String",
+ "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "emptyResultText",
+ "type" : "Boolean",
+ "desc" : "only for touch device",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "emptyTitle",
+ "type" : "String",
+ "desc" : "default ''",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.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.bootstrap.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.bootstrap.form.Input"
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "mobileTouchView",
+ "type" : "Boolean",
+ "desc" : "e) show mobile touch view when using a mobile default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "mobile_restrict_height",
+ "type" : "Boolean",
+ "desc" : "e) restrict height for touch view",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "modalTitle",
+ "type" : "String",
+ "desc" : "The title of the dialog that pops up on mobile views.",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "multiple",
+ "type" : "Boolean",
+ "desc" : "e) ComboBobArray, default false",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "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.form.ComboBox"
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.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.form.ComboBox"
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.form.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.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.bootstrap.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.bootstrap.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "showToggleBtn",
+ "type" : "Boolean",
+ "desc" : "show toggle button or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "specialFilter",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "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" : "Roo.bootstrap.form.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.form.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.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" : "Roo.bootstrap.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' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
+ {
+ "name" : "triggerList",
+ "type" : "Boolean",
+ "desc" : "trigger show the list or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "triggerText",
+ "type" : "String",
+ "desc" : "multiple combobox trigger button text default 'Select'",
+ "memberOf" : "Roo.bootstrap.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" : "Roo.bootstrap.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" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "useNativeIOS",
+ "type" : "Boolean",
+ "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.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.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "fixed with? experimental",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "add",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "afterremove",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforequery",
+ "type" : "function",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The query event object",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isVisible",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "on",
+ "name" : "beforeselect",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "blur",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "change",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "disable",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "edit",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "expand",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.PagingToolbar" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignment",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "buttons[]",
- "type" : "Roo.bootstrap.Button",
- "desc" : "Buttons for the toolbar",
- "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",
- "type" : "String/HTMLElement/Element",
- "desc" : "container The id or element that will contain the toolbar",
- "memberOf" : ""
- },
- {
- "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" : "displayInfo",
- "type" : "Boolean",
- "desc" : "True to display the displayMsg (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "displayMsg",
- "type" : "String",
- "desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
- "memberOf" : ""
- },
- {
- "name" : "emptyMsg",
- "type" : "String",
- "desc" : "The message to display when no records are found (defaults to \"No data to display\")",
- "memberOf" : ""
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "The number of records to display per page (defaults to 20)",
- "memberOf" : ""
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The underlying data store providing the paged data",
- "memberOf" : ""
- },
- {
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
- },
- {
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : "Roo.bootstrap.NavSimplebar"
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "invalid",
"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 after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "keyup",
"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" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforetoggle",
+ "name" : "paste",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Navbar",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "specialfilter",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when specialfilter",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
}
],
"returns" : []
},
{
- "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.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "tick",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when tick the element",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "touchviewdisplay",
+ "type" : "function",
+ "desc" : "Fires when touch view require special display (default is using displayField)",
+ "sig" : "function (combo, cfg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "set html .",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "bind",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Binds the paging toolbar to the specified {@link Roo.data.Store}",
- "sig" : "(store)",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to bind",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "collapse",
"type" : "function",
- "desc" : "Collapse the navbar pulldown",
+ "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.Navbar",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
{
"name" : "expand",
"type" : "function",
- "desc" : "Expand the navbar pulldown",
+ "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.Navbar",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "value The selected value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets 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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value to match",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"returns" : []
},
{
- "name" : "unbind",
+ "name" : "validate",
"type" : "function",
- "desc" : "Unbinds the paging toolbar from the specified {@link Roo.data.Store}",
- "sig" : "(store)",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to unbind",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.form.ComboBox" : [
+ "Roo.bootstrap.form.MoneyField"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.PhoneInput" : {
+ "Roo.bootstrap.form.DateField" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "accept",
"type" : "String",
"desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "actionMode",
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "align",
"type" : "String",
"desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"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" : "Roo.bootstrap.form.DateField"
+ },
{
"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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "calendarWeeks",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "can_build_overlaid",
"name" : "capture",
"type" : "String",
"desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : "Roo.bootstrap.TriggerField"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "cls",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "defaultDialCode",
- "type" : "String",
- "desc" : "default '+852'",
- "memberOf" : ""
+ "name" : "daysOfWeekDisabled",
+ "type" : "Object",
+ "desc" : "default empty",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "disableClass",
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "endDate",
+ "type" : "Number",
+ "desc" : "default Infinity",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "forceFeedback",
"type" : "Boolean",
"desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "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" : "Roo.bootstrap.form.DateField"
},
{
"name" : "hasFeedback",
"type" : "Boolean",
"desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "hideMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.TriggerField"
- },
{
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "keyboardNavigation",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "labelAlign",
"type" : "String",
"desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "language",
+ "type" : "String",
+ "desc" : "default en",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "listeners",
"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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minViewMode",
+ "type" : "String",
+ "desc" : "default empty, (months|years)",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "preferedCountries",
- "type" : "Array",
- "desc" : "default []",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "removable",
+ "name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.TriggerField"
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "selectOnFocus",
+ "name" : "singleMode",
"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" : "default false (true | false)",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "[required] The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
+ "name" : "startDate",
+ "type" : "Number",
+ "desc" : "default -Infinity",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "todayBtn",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "Roo.bootstrap.form.DateField"
+ },
+ {
+ "name" : "todayHighlight",
+ "type" : "Boolean",
+ "desc" : "default false",
+ "memberOf" : "Roo.bootstrap.form.DateField"
+ },
{
"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",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "viewMode",
+ "type" : "String",
+ "desc" : "default empty, (months|years)",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "visibilityEl",
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "weekStart",
+ "type" : "Number",
+ "desc" : "default 0",
+ "memberOf" : "Roo.bootstrap.form.DateField"
},
{
"name" : "xattr",
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires when before select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.DateField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforeshow",
"type" : "function",
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires just before the field blurs if the field value has changed.",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the user pastes into input",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.DateField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires 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" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.DateField",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
}
],
"returns" : []
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
"desc" : "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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Popover" : {
+ "Roo.bootstrap.form.DateSplitField" : {
"props" : [
- {
- "name" : "(right|top|bottom|left|auto)",
- "type" : "String|function",
- "desc" : "placement how it is placed",
- "memberOf" : ""
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "add",
- "type" : "String|Boolean|Roo.Element",
- "desc" : "click hander to trigger show over what element\n - if false and it has a 'parent' then it will be automatically added to that element\n - if string - Roo.get will be called",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "delay",
- "type" : "Number",
- "desc" : "- delay before showing",
- "memberOf" : ""
+ "name" : "dayAllowBlank",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "dayFormat",
+ "type" : "string",
+ "desc" : "default 'd'",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "dayPlaceholder",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
},
{
"name" : "disableClass",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "contents of the popover (or false to use children..)",
- "memberOf" : ""
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label (0-12)",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "modal",
+ "name" : "monthAllowBlank",
"type" : "Boolean",
- "desc" : "- popovers that are modal will mask the screen, and must be closed with another event.",
- "memberOf" : ""
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "monthFormat",
+ "type" : "string",
+ "desc" : "default 'm'",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "monthPlaceholder",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
},
{
"name" : "name",
"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",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "yearAllowBlank",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "yearFormat",
+ "type" : "string",
+ "desc" : "default 'Y'",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
+ },
+ {
+ "name" : "yearPlaceholder",
+ "type" : "string",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.DateSplitField"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "days",
+ "type" : "function",
+ "desc" : "getting the data of days",
+ "sig" : "function (_self, days)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.DateSplitField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "days",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"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" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Popover",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
}
],
"returns" : []
{
"name" : "show",
"type" : "function",
- "desc" : "After the popover show",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Popover",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "years",
+ "type" : "function",
+ "desc" : "getting the data of years",
+ "sig" : "function (_self, years)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.DateSplitField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "years",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setContent",
- "type" : "function",
- "desc" : "",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "body content",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "title",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
{
"name" : "show",
"type" : "function",
- "desc" : "Show the popover",
- "sig" : "(-, (left|right|top|bottom))",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "-",
- "type" : "Roo.Element|string|Boolean",
- "desc" : "element to align and point to. (set align to [ pos, offset ])",
- "isOptional" : false
- },
- {
- "name" : "(left|right|top|bottom)",
- "type" : "string",
- "desc" : "position",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
}
],
"returns" : []
- },
- {
- "name" : "updatePosition",
- "type" : "function",
- "desc" : "fire this manually after loading a grid in the table for example",
- "sig" : "((left|right|top|bottom), try)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "(left|right|top|bottom)",
- "type" : "string",
- "desc" : "where to try and put it (use false to use the last one)",
- "isOptional" : false
- },
- {
- "name" : "try",
- "type" : "Boolean",
- "desc" : "and move it if we cant get right position.",
- "isOptional" : false
- }
- ],
- "returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.PopoverNav" : {
+ "Roo.bootstrap.form.FieldLabel" : {
"props" : [
{
"name" : "actionMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.NavGroup"
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "e) target allowBlank default true",
+ "memberOf" : "Roo.bootstrap.form.FieldLabel"
},
{
"name" : "allowDomMove",
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "class of the element",
+ "memberOf" : "Roo.bootstrap.form.FieldLabel"
},
{
"name" : "container_method",
"memberOf" : "Roo.Component"
},
{
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.bootstrap.NavGroup"
+ "name" : "html",
+ "type" : "String",
+ "desc" : "contents of the element",
+ "memberOf" : "Roo.bootstrap.form.FieldLabel"
+ },
+ {
+ "name" : "iconTooltip",
+ "type" : "String",
+ "desc" : "default \"This field is required\"",
+ "memberOf" : "Roo.bootstrap.form.FieldLabel"
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.FieldLabel"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - BS4 uses is-invalid",
+ "memberOf" : "Roo.bootstrap.form.FieldLabel"
},
{
"name" : "listeners",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "navId",
+ "name" : "style",
"type" : "String",
- "desc" : "- reference Id for navbar.",
- "memberOf" : "Roo.bootstrap.NavGroup"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "pilltype",
- "type" : "Boolean",
- "desc" : "default true (turn to off to disable active toggle)",
- "memberOf" : "Roo.bootstrap.NavGroup"
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "tag of the element default label",
+ "memberOf" : "Roo.bootstrap.form.FieldLabel"
},
{
- "name" : "style",
+ "name" : "target",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "label target",
+ "memberOf" : "Roo.bootstrap.form.FieldLabel"
},
{
"name" : "tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "type",
+ "name" : "validClass",
"type" : "String",
- "desc" : "b) default nav",
- "memberOf" : "Roo.bootstrap.NavGroup"
+ "desc" : "DEPRICATED - BS4 uses is-valid",
+ "memberOf" : "Roo.bootstrap.form.FieldLabel"
},
{
"name" : "visibilityEl",
],
"returns" : []
},
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.NavGroup",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.NavGroup",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "selected",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The item selected",
- "isOptional" : false
- },
- {
- "name" : "prev",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The previously selected item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.FieldLabel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "valid",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.form.FieldLabel",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "addItem",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "adds a Navigation item",
- "sig" : "(the)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "navitem to add",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "clearAll",
- "type" : "function",
- "desc" : "clear all the Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "get",
"type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID",
- "sig" : "(the)",
+ "desc" : "fetch a FieldLabel Group based on the target",
+ "sig" : "(target)",
"static" : true,
- "memberOf" : "Roo.bootstrap.NavGroup",
+ "memberOf" : "",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
+ "name" : "target",
"type" : "string",
- "desc" : "navgroup to add",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "getActive",
- "type" : "function",
- "desc" : "gets the active Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "the current navitem"
- }
- ]
- },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
{
"name" : "register",
"type" : "function",
- "desc" : "register a Navigation item",
+ "desc" : "register a FieldLabel Group",
"sig" : "(the)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
- "isStatic" : false,
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"params" : [
{
"name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "navitem to add",
+ "type" : "Roo.bootstrap.form.FieldLabel",
+ "desc" : "FieldLabel to add",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "setActiveItem",
- "type" : "function",
- "desc" : "sets the active Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.NavGroup",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "new current navitem",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Progress" : {
+ "Roo.bootstrap.form.Form" : {
"props" : [
{
"name" : "actionMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : "animated of the progress bar",
- "memberOf" : ""
+ "name" : "align",
+ "type" : "String",
+ "desc" : "left | right - for navbars",
+ "memberOf" : "Roo.bootstrap.form.Form"
},
{
"name" : "allowDomMove",
"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" : "Roo.bootstrap.form.Form"
+ },
{
"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" : "errorMask",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.form.Form"
+ },
+ {
+ "name" : "fileUpload",
+ "type" : "Boolean",
+ "desc" : "Set to true if this form is a file upload.",
+ "memberOf" : "Roo.bootstrap.form.Form"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "top | left (default top)",
+ "memberOf" : "Roo.bootstrap.form.Form"
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "load mask when submit (default true)",
+ "memberOf" : "Roo.bootstrap.form.Form"
+ },
+ {
+ "name" : "maskBody",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Form"
+ },
+ {
+ "name" : "maskOffset",
+ "type" : "Number",
+ "desc" : "Default 100",
+ "memberOf" : "Roo.bootstrap.form.Form"
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "GET | POST (default POST)",
+ "memberOf" : "Roo.bootstrap.form.Form"
+ },
{
"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" : "timeout",
+ "type" : "Number",
+ "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf" : "Roo.bootstrap.form.Form"
+ },
{
"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" : "Roo.bootstrap.form.Form"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
+ {
+ "name" : "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" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that completed",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "actionfailed",
+ "type" : "function",
+ "desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that failed",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeaction",
+ "type" : "function",
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action to be performed",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clientvalidation",
+ "type" : "function",
+ "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
+ "sig" : "function (_self, valid)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "valid",
+ "type" : "Boolean",
+ "desc" : "true if the form has passed client-side validation",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clears all invalid messages in this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "doAction",
+ "type" : "function",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "actionName",
+ "type" : "String",
+ "desc" : "The name of the action type",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "findField",
+ "type" : "function",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The value to search for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Field"
+ }
+ ]
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
+ {
+ "name" : "getFieldValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs.\nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "getId",
"type" : "function",
}
]
},
+ {
+ "name" : "getValues",
+ "type" : "function",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "asString",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if any fields in this form have changed since their original load.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns true if client-side validation on the form is successful.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "errors",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setValues",
+ "type" : "function",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "values",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.ProgressBar" : {
+ "Roo.bootstrap.form.HtmlEditor" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "aria_valuemax",
- "type" : "Number",
- "desc" : "aria-value max",
- "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.form.Input"
},
{
- "name" : "aria_valuemin",
- "type" : "Number",
- "desc" : "aria-value min",
- "memberOf" : ""
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "aria_valuenow",
- "type" : "Number",
- "desc" : "aria-value now",
- "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.form.Input"
+ },
+ {
+ "name" : "buttons",
+ "type" : "Array",
+ "desc" : "Array of toolbar's buttons. - defaults to empty",
+ "memberOf" : "Roo.bootstrap.form.HtmlEditor"
},
{
"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.form.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.form.TextArea"
+ },
{
"name" : "container_method",
"type" : "string",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "(in pixels)",
+ "memberOf" : "Roo.bootstrap.form.HtmlEditor"
+ },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "label",
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
+ },
+ {
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "label for the progress bar",
- "memberOf" : ""
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"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.form.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "panel",
- "type" : "String",
- "desc" : ")",
- "memberOf" : ""
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "role",
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "role of the progress bar",
- "memberOf" : ""
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "sr_only",
+ "name" : "resizable",
"type" : "String",
- "desc" : "text",
- "memberOf" : ""
+ "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
+ "memberOf" : "Roo.bootstrap.form.HtmlEditor"
+ },
+ {
+ "name" : "resize",
+ "type" : "string",
+ "desc" : "l)",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
+ },
+ {
+ "name" : "rows",
+ "type" : "Number",
+ "desc" : "Specifies the visible number of lines in a text area",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.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" : "Roo.bootstrap.form.HtmlEditor"
+ },
+ {
+ "name" : "toolbars",
+ "type" : "Array",
+ "desc" : "Array of toolbars. - defaults to just the Standard one",
+ "memberOf" : "Roo.bootstrap.form.HtmlEditor"
+ },
{
"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.form.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "(in pixels)",
+ "memberOf" : "Roo.bootstrap.form.HtmlEditor"
+ },
+ {
+ "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.form.TextArea"
+ },
{
"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.form.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" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autosave",
+ "type" : "function",
+ "desc" : "Auto save the htmlEditor value as a file into Events",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "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" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
+ {
+ "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" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "editmodechange",
+ "type" : "function",
+ "desc" : "Fires when the editor switches edit modes",
+ "sig" : "function (_self, sourceEdit)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "sourceEdit",
+ "type" : "Boolean",
+ "desc" : "True if source edit, false if standard editing.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "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" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "firstfocus",
+ "type" : "function",
+ "desc" : "Fires when on first focus - needed by toolbars..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initialize",
+ "type" : "function",
+ "desc" : "Fires when the editor is fully initialized (including the iframe)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "push",
+ "type" : "function",
+ "desc" : "Fires when the iframe editor is updated with content from the textarea.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "savedpreview",
+ "type" : "function",
+ "desc" : "preview the saved version of htmlEditor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "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" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "editor",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real textarea element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "toggleSourceEdit",
+ "type" : "function",
+ "desc" : "Toggles the editor between standard and source edit mode.",
+ "sig" : "(sourceEdit)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "sourceEdit",
+ "type" : "Boolean",
+ "desc" : "(optional) True for source edit, false for standard",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "tooltipEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Radio" : {
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"memberOf" : "Roo.Component"
},
{
- "name" : "boxLabel",
- "type" : "String",
- "desc" : "- the label associated",
- "memberOf" : ""
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "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" : "Roo.bootstrap.form.HtmlEditorToolbarStandard"
},
{
"name" : "can_build_overlaid",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "disable",
+ "type" : "Object",
+ "desc" : "List of elements to disable..",
+ "memberOf" : "Roo.bootstrap.form.HtmlEditorToolbarStandard"
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "name",
"type" : "string",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "tooltip",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "value",
+ "name" : "type",
"type" : "String",
- "desc" : "- the value of radio",
- "memberOf" : ""
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "visibilityEl",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "xattr",
"type" : "Object",
],
"returns" : []
},
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : [
+ "Roo.bootstrap.form.HtmlEditor"
]
},
- "Roo.bootstrap.RadioSet" : {
+ "Roo.bootstrap.form.Input" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "accept",
"type" : "String",
"desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "actionMode",
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "align",
"type" : "String",
"desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "allowDomMove",
"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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "can_build_overlaid",
"name" : "capture",
"type" : "String",
"desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "cls",
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "forceFeedback",
"type" : "Boolean",
"desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "hasFeedback",
"type" : "Boolean",
"desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "hideMode",
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default left",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "inline",
- "type" : "Boolean",
- "desc" : "e) inline the element (default true)",
- "memberOf" : ""
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelAlign",
"type" : "String",
"desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "listeners",
"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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "style",
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "visibilityEl",
"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" : ""
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "xattr",
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
}
],
"events" : [
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"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" : "",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the element is checked or unchecked.",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.RadioSet",
- "desc" : "This radio",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.Radio",
- "desc" : "The checked item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when the element is click.",
- "sig" : "function (_self, item, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.RadioSet",
- "desc" : "This radio set",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.Radio",
- "desc" : "The checked item",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the user pastes into input",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"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",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.form.TextArea" : [
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown"
+ ],
+ "Roo.bootstrap.form.TriggerField" : [
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.PhoneInput"
+ ],
+ "Roo.bootstrap.form.ComboBox" : [
+ "Roo.bootstrap.form.MoneyField"
+ ],
+ "Roo.bootstrap.form.Input" : [
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Row" : {
+ "Roo.bootstrap.form.Markdown" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.TextArea"
+ },
{
"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" : "",
+ "memberOf" : "Roo.bootstrap.form.Markdown"
+ },
{
"name" : "dataId",
"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.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "resize",
+ "type" : "string",
+ "desc" : "l)",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
+ },
+ {
+ "name" : "rows",
+ "type" : "Number",
+ "desc" : "Specifies the visible number of lines in a text area",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.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" : "Roo.bootstrap.form.TextArea"
+ },
{
"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.form.Input"
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "paste",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "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.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "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.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real textarea element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.SecurePass" : {
- "props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
},
{
- "name" : "Label",
- "type" : "String/Object",
- "desc" : "for the strength meter (defaults to\n'Password strength:')",
- "memberOf" : ""
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
},
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form.MoneyField" : {
+ "props" : [
{
"name" : "accept",
"type" : "String",
"desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "actionMode",
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "align",
"type" : "String",
"desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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.form.ComboBox"
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
},
{
"name" : "allowDomMove",
"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" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "name" : "allowZero",
+ "type" : "Boolean",
+ "desc" : "False to blank out if the user enters '0' (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "autoFocus",
+ "type" : "Boolean",
+ "desc" : "e) auto focus the first item, default true",
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "btnPosition",
+ "type" : "String",
+ "desc" : "set the position of the trigger button (left | right) default right",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "can_build_overlaid",
"name" : "capture",
"type" : "String",
"desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
+ {
+ "name" : "castInt",
+ "type" : "Boolean",
+ "desc" : "e) cast int if true (defalut true)",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
},
{
"name" : "cls",
"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" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "name" : "decimalSeparator",
+ "type" : "String",
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "name" : "defaults",
+ "type" : "String",
+ "desc" : "currency of the MoneyField\nvalue should be in lkey",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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" : "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.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "emptyResultText",
+ "type" : "Boolean",
+ "desc" : "only for touch device",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "emptyTitle",
+ "type" : "String",
+ "desc" : "default ''",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "forceFeedback",
"type" : "Boolean",
"desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceSelection",
+ "type" : "Boolean",
+ "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.form.ComboBox"
},
{
"name" : "hasFeedback",
"type" : "Boolean",
"desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "hideMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
{
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidClass",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelAlign",
"type" : "String",
"desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "lazyRender",
+ "type" : "Boolean",
+ "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "listAlign",
+ "type" : "String",
+ "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.form.ComboBox"
},
{
"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" : "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.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.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "name" : "max_length",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minChars",
+ "type" : "Number",
+ "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minListWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf" : "Roo.bootstrap.form.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" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "name" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "name" : "mobileTouchView",
+ "type" : "Boolean",
+ "desc" : "e) show mobile touch view when using a mobile default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "mobile_restrict_height",
+ "type" : "Boolean",
+ "desc" : "e) restrict height for touch view",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "modalTitle",
+ "type" : "String",
+ "desc" : "The title of the dialog that pops up on mobile views.",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "multiple",
+ "type" : "Boolean",
+ "desc" : "e) ComboBobArray, default false",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "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.form.ComboBox"
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "pwdStrengths",
- "type" : "String/Object",
- "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
- "memberOf" : ""
+ "name" : "queryDelay",
+ "type" : "Number",
+ "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.form.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.form.ComboBox"
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf" : "Roo.bootstrap.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.bootstrap.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.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "showToggleBtn",
+ "type" : "Boolean",
+ "desc" : "show toggle button or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "specialFilter",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "Store to lookup currency??",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "thousandsDelimiter",
+ "type" : "String",
+ "desc" : "Symbol of thousandsDelimiter",
+ "memberOf" : "Roo.bootstrap.form.MoneyField"
+ },
+ {
+ "name" : "tickable",
+ "type" : "Boolean",
+ "desc" : "ComboBox with tickable selections (true|false), default false",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.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" : "Roo.bootstrap.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' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
+ {
+ "name" : "triggerList",
+ "type" : "Boolean",
+ "desc" : "trigger show the list or not (true|false) default true",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "triggerText",
+ "type" : "String",
+ "desc" : "multiple combobox trigger button text default 'Select'",
+ "memberOf" : "Roo.bootstrap.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" : "Roo.bootstrap.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" : "Roo.bootstrap.form.ComboBox"
+ },
+ {
+ "name" : "useNativeIOS",
+ "type" : "Boolean",
+ "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
+ },
{
"name" : "validClass",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "DEPRICATED - uses BS4 is-valid now",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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.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.bootstrap.form.ComboBox"
},
{
"name" : "visibilityEl",
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "fixed with? experimental",
+ "memberOf" : "Roo.bootstrap.form.ComboBox"
},
{
"name" : "xattr",
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterremove",
+ "type" : "function",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforequery",
+ "type" : "function",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The query event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforeshow",
"type" : "function",
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires just before the field blurs if the field value has changed.",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "focus",
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the user pastes into input",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when the remove value from the combobox array",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "specialfilter",
+ "type" : "function",
+ "desc" : "Fires when specialfilter",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "specialkey",
"type" : "function",
"desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
+ {
+ "name" : "tick",
+ "type" : "function",
+ "desc" : "Fires when tick the element",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "touchviewdisplay",
+ "type" : "function",
+ "desc" : "Fires when touch view require special display (default is using displayField)",
+ "sig" : "function (combo, cfg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.bootstrap.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "set html .",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "valid",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "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.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
"desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"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.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "String",
+ "desc" : "value The selected value"
}
]
},
"desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "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.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reset",
+ "name" : "setEditable",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
+ "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.Input",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setFromData",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "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.Component",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
"isOptional" : false
}
],
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"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.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "type" : "String",
+ "desc" : "The value to match",
"isOptional" : false
}
],
"desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Slider" : {
+ "Roo.bootstrap.form.MonthField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "language",
+ "type" : "String",
+ "desc" : "default en",
+ "memberOf" : "Roo.bootstrap.form.MonthField"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
}
],
"events" : [
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "enable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "render",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "show",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "hide",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "invalid",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
+ "name" : "paste",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "render",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "this",
"type" : "Roo.Component",
- "desc" : "this"
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, oldvalue, newvalue)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.MonthField",
"desc" : "",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "oldvalue",
+ "type" : "String",
+ "desc" : "The old value",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "newvalue",
+ "type" : "String",
+ "desc" : "The new value",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "show",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this field show.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.MonthField",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "valid",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getVisibilityEl",
- "type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "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",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
- "type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
+ "name" : "capture",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
"static" : true,
"memberOf" : "Roo.util.Observable",
"isStatic" : true,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to release",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "render",
+ "name" : "destroy",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "disable",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setVisibilityEl",
+ "name" : "enable",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setVisible",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "show",
+ "name" : "focus",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "tooltipEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.bootstrap.Component",
]
},
{
- "name" : "un",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ]
- },
- "Roo.bootstrap.SplitBar" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
- {
- "name" : "beforeresize",
- "type" : "function",
- "desc" : "Fires before the splitter is dragged",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "moved",
- "type" : "function",
- "desc" : "Fires when the splitter is moved",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "",
- "isOptional" : false
- },
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "the new width or height",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "resize",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fires when the splitter is moved (alias for {@link #event-moved})",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "the new width or height",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "getName",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "capture",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "destroy",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Destroy this splitbar.",
- "sig" : "(removeEl)",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "True to remove the element",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getAdapter",
+ "name" : "hide",
"type" : "function",
- "desc" : "Get the adapter this SplitBar uses",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "The adapter object"
- }
- ]
+ "returns" : []
},
{
- "name" : "getMaximumSize",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Gets the maximum size for the resizing element",
+ "desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The maximum size"
- }
- ]
+ "returns" : []
},
{
- "name" : "getMinimumSize",
+ "name" : "inputEl",
"type" : "function",
- "desc" : "Gets the minimum size for the resizing element",
+ "desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The minimum size"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "msg",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The validation message",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "setAdapter",
+ "name" : "render",
"type" : "function",
- "desc" : "Set the adapter this SplitBar uses",
- "sig" : "(adapter)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "adapter",
- "type" : "Object",
- "desc" : "A SplitBar adapter object",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setCurrentSize",
+ "name" : "reset",
"type" : "function",
- "desc" : "Sets the initialize size for the resizing element",
- "sig" : "(size)",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "size",
- "type" : "Number",
- "desc" : "The initial size",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setMaximumSize",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Sets the maximum size for the resizing element",
- "sig" : "(maxSize)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maxSize",
- "type" : "Number",
- "desc" : "The maximum size",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setMinimumSize",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Sets the minimum size for the resizing element",
- "sig" : "(minSize)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "minSize",
- "type" : "Number",
- "desc" : "The minimum size",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getElementSize",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setElementSize",
+ "name" : "un",
"type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.bootstrap.SplitBar.BasicLayoutAdapter",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size to set",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "A function to be invoked when resizing is complete",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getElementSize",
+ "name" : "validate",
"type" : "function",
- "desc" : "Called before drag operations to get the current size of the resizing element.",
- "sig" : "(s)",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setElementSize",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Called after drag operations to set the size of the resizing element.",
- "sig" : "(s, newSize, onComplete)",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Roo.bootstrap.SplitBar",
- "desc" : "The SplitBar using this adapter",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size to set",
- "isOptional" : false
- },
- {
- "name" : "onComplete",
- "type" : "Function",
- "desc" : "A function to be invoked when resizing is complete",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.TabGroup" : {
+ "Roo.bootstrap.form.NumberField" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "alert",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "align",
"type" : "String",
- "desc" : "r) type alert (changes background / border...)",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.NumberField"
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "autoslide",
+ "name" : "allowNegative",
"type" : "Boolean",
- "desc" : "e) auto slide .. default false",
- "memberOf" : ""
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.NumberField"
},
{
- "name" : "bullets",
+ "name" : "allowZero",
"type" : "Boolean",
- "desc" : "show bullets for the panels",
- "memberOf" : ""
+ "desc" : "False to blank out if the user enters '0' (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.NumberField"
+ },
+ {
+ "name" : "autocomplete",
+ "type" : "String",
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
},
{
"name" : "can_build_overlaid",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "carousel",
- "type" : "Boolean",
- "desc" : "true to make the group behave like a carousel",
- "memberOf" : ""
+ "name" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "cls",
"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" : "Roo.bootstrap.form.NumberField"
+ },
+ {
+ "name" : "decimalSeparator",
+ "type" : "String",
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf" : "Roo.bootstrap.form.NumberField"
+ },
{
"name" : "disableClass",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "fa",
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "focusClass",
"type" : "String",
- "desc" : ".) font awesome icon",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "fasize",
- "type" : "Number",
- "desc" : ".) font awsome size",
- "memberOf" : "Roo.bootstrap.Column"
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "hidden",
+ "name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) hide the element",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "content of column.",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "icon",
+ "name" : "inputType",
"type" : "String",
- "desc" : ".) glyphicon name",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "lg",
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
"type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "lgoff",
+ "name" : "labellg",
"type" : "Number",
- "desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"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.form.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "maxText",
+ "type" : "String",
+ "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "memberOf" : "Roo.bootstrap.form.NumberField"
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.NumberField"
+ },
{
"name" : "md",
"type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "mdoff",
+ "name" : "minLength",
"type" : "Number",
- "desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.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.form.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" : "Roo.bootstrap.form.NumberField"
+ },
+ {
+ "name" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf" : "Roo.bootstrap.form.NumberField"
},
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.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" : "Roo.bootstrap.form.NumberField"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "navId",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
- "memberOf" : ""
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "showarrow",
+ "name" : "selectOnFocus",
"type" : "Boolean",
- "desc" : "e) show arrow default true",
- "memberOf" : ""
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "smoff",
+ "name" : "sm",
"type" : "Number",
- "desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "timer",
- "type" : "Number",
- "desc" : "auto slide timer .. default 0 millisecond",
- "memberOf" : ""
+ "name" : "thousandsDelimiter",
+ "type" : "String",
+ "desc" : "Symbol of thousandsDelimiter",
+ "memberOf" : "Roo.bootstrap.form.NumberField"
},
{
"name" : "tooltip",
"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.form.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "valueAlign",
+ "type" : "String",
+ "desc" : "alignment of value",
+ "memberOf" : "Roo.bootstrap.form.NumberField"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "xattr",
"type" : "Object",
{
"name" : "xs",
"type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
- },
- {
- "name" : "xsoff",
- "type" : "Number",
- "desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "colspan out of 12 for mobile-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "paste",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "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.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "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.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID\nif one does not exist , it will get created.",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"returns" : []
},
{
- "name" : "on",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "msg",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "markValid",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "register",
+ "name" : "on",
"type" : "function",
- "desc" : "register a Navigation item",
- "sig" : "(the)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Roo.bootstrap.NavItem",
- "desc" : "navitem to add",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "register",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "register a Navigation Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.NavGroup",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.bootstrap.Component",
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "show a specific panel",
- "sig" : "(panel)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Roo.bootstrap.TabPanel|number|string",
- "desc" : "to change to (use the tabId to specify a specific one)",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "false if panel was not shown (invalid entry or beforedeactivate fails.)"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "tooltipEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.TabPanel" : {
+ "Roo.bootstrap.form.PhoneInput" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "active",
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowBlank",
"type" : "Boolean",
- "desc" : "panel active",
- "memberOf" : ""
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
{
"name" : "cls",
"type" : "String",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "defaultDialCode",
+ "type" : "String",
+ "desc" : "default '+852'",
+ "memberOf" : "Roo.bootstrap.form.PhoneInput"
+ },
{
"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.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "href",
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
+ {
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "click to link..",
- "memberOf" : ""
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "html",
+ "name" : "inputType",
"type" : "String",
- "desc" : "panel content",
- "memberOf" : ""
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"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.form.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "navId",
+ "name" : "preferedCountries",
+ "type" : "Array",
+ "desc" : "default []",
+ "memberOf" : "Roo.bootstrap.form.PhoneInput"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "The Roo.bootstrap.NavGroup which triggers show hide ()",
- "memberOf" : ""
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "[required] The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "Roo.bootstrap.form.PhoneInput"
},
{
"name" : "style",
"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",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "touchSlide",
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validateOnBlur",
"type" : "Boolean",
- "desc" : "if swiping slides tab to next panel (default off)",
- "memberOf" : ""
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "visibilityEl",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
}
],
"events" : [
{
- "name" : "beforedeactivate",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires before a tab is de-activated - can be used to do validation on a form.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.TabPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "false if there is an error"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "changed",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires when the active status changes",
- "sig" : "function (_self, state)\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.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.TabPanel",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "state",
- "type" : "Boolean",
- "desc" : "the new state",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
{
"name" : "focus",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getName",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Mixed",
+ "desc" : "name The name field"
}
]
},
{
- "name" : "getEl",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "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.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
{
- "name" : "getId",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "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.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Table" : {
+ "Roo.bootstrap.form.Radio" : {
"props" : [
{
"name" : "actionMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "auto_hide_footer",
- "type" : "Boolean",
- "desc" : "auto hide footer if only one page (default false)",
- "memberOf" : ""
- },
- {
- "name" : "bordered",
- "type" : "boolean",
- "desc" : "Add borders to the table",
- "memberOf" : ""
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Radio"
},
{
"name" : "can_build_overlaid",
"desc" : "True if element can be rebuild from a HTML page",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "cellSelection",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "cls",
"type" : "String",
- "desc" : "table class",
- "memberOf" : ""
- },
- {
- "name" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "A column for the grid.",
- "memberOf" : ""
- },
- {
- "name" : "condensed",
- "type" : "boolean",
- "desc" : "Format condensed",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "enableColumnResize",
- "type" : "Boolean",
- "desc" : "default true if columns can be resized (drag/drop)",
- "memberOf" : ""
- },
- {
- "name" : "footer",
- "type" : "Roo.bootstrap.PagingToolbar",
- "desc" : "a paging toolbar",
- "memberOf" : ""
- },
- {
- "name" : "footerShow",
- "type" : "Boolean",
- "desc" : "e) generate tfoot, default true",
- "memberOf" : ""
- },
- {
- "name" : "headerShow",
- "type" : "Boolean",
- "desc" : "e) generate thead, default true",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "hover",
- "type" : "boolean",
- "desc" : "Add hover highlighting",
- "memberOf" : ""
- },
- {
- "name" : "lazyLoad",
- "type" : "Boolean",
- "desc" : "auto load data while scrolling to the end (default false)",
- "memberOf" : ""
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
- {
- "name" : "minColumnWidth",
- "type" : "Number",
- "desc" : "default 50 pixels minimum column width",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "responsive",
- "type" : "boolean",
- "desc" : "default false - if this is on, columns are rendered with col-xs-4 etc. classes, otherwise columns will be sized by CSS,\n also adds table-responsive (see bootstrap docs for details)",
- "memberOf" : ""
- },
- {
- "name" : "rowSelection",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
- {
- "name" : "scrollBody",
- "type" : "Boolean",
- "desc" : "e) default false - body scrolled / fixed header",
- "memberOf" : ""
- },
- {
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection model to use (cell selection is not supported yet)",
- "memberOf" : ""
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to use",
- "memberOf" : ""
- },
- {
- "name" : "striped",
- "type" : "boolean",
- "desc" : "Should the rows be alternative striped",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "- the value of radio",
+ "memberOf" : "Roo.bootstrap.form.Radio"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
],
"returns" : []
},
- {
- "name" : "cellclick",
- "type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "cellcontextmenu",
- "type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cellIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "celldblclick",
- "type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "contextmenu",
- "type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "headercontextmenu",
- "type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "mousedown",
- "type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseout",
- "type" : "function",
- "desc" : "Fires when a mouseout occur",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseover",
- "type" : "function",
- "desc" : "Fires when a mouseover occur",
- "sig" : "function (_self, el, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "rowclass",
- "type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (_self, rowcfg)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex colIndex and rowClass - set rowClass to add a style.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowclick",
- "type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowcontextmenu",
- "type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowdblclick",
- "type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, el, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "el",
- "type" : "Roo.Element",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowsrendered",
- "type" : "function",
- "desc" : "Fires when all the rows have been rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Table",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Forces a resize - used by panel.Grid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Element",
- "desc" : "The element"
- }
- ]
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clear",
- "type" : "function",
- "desc" : "Remove all rows",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "ensureVisible",
- "type" : "function",
- "desc" : "Scrolls the specified cell into view",
- "sig" : "(row, col, hscroll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "focusCell",
- "type" : "function",
- "desc" : "Focuses the specified cell.",
- "sig" : "(row, col, hscroll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focusRow",
- "type" : "function",
- "desc" : "Focuses the specified row.",
- "sig" : "(row)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getCellIndex",
- "type" : "function",
- "desc" : "get the Column Index from a dom element. (using regex on x-hcol-{colid})",
- "sig" : "(cell)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cell",
- "type" : "domElement",
- "desc" : "to look for",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
- {
- "name" : "getGridEl",
- "type" : "function",
- "desc" : "Returns the grid's underlying element = used by panel.Grid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getHeaderIndex",
- "type" : "function",
- "desc" : "get the header TH element for columnIndex",
- "sig" : "(columnIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getId",
"type" : "function",
}
]
},
- {
- "name" : "getRowIndex",
- "type" : "function",
- "desc" : "get the Row Index from a dom element.",
- "sig" : "(row)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Roo.Element",
- "desc" : "The row to look for",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getVisibilityEl",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRowVisibility",
- "type" : "function",
- "desc" : "Show or hide a row.",
- "sig" : "(rowIndex, state)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "to show or hide",
- "isOptional" : false
- },
- {
- "name" : "state",
- "type" : "Boolean",
- "desc" : "hide",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.TableBody" : {
+ "Roo.bootstrap.form.RadioSet" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "align",
"type" : "String",
- "desc" : "Aligns the content inside the element",
- "memberOf" : ""
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"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" : "capture",
+ "type" : "String",
+ "desc" : "a) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "cls",
"type" : "String",
- "desc" : "element class",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "container_method",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.RadioSet"
+ },
+ {
+ "name" : "inline",
+ "type" : "Boolean",
+ "desc" : "e) inline the element (default true)",
+ "memberOf" : "Roo.bootstrap.form.RadioSet"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "element tag (thead|tbody|tfoot) default tbody",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "valign",
+ "name" : "validClass",
"type" : "String",
- "desc" : "Vertical aligns the content inside the <tbody> element",
- "memberOf" : ""
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "visibilityEl",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "s) The text that appears beside the radio",
+ "memberOf" : "Roo.bootstrap.form.RadioSet"
+ },
{
"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.form.Input"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "check",
+ "type" : "function",
+ "desc" : "Fires when the element is checked or unchecked.",
+ "sig" : "function (_self, item)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.RadioSet",
+ "desc" : "This radio",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.bootstrap.form.Radio",
+ "desc" : "The checked item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when the element is click.",
+ "sig" : "function (_self, item, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.RadioSet",
+ "desc" : "This radio set",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.bootstrap.form.Radio",
+ "desc" : "The checked item",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.form.Radio"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.TableCell" : {
+ "Roo.bootstrap.form.SecurePass" : {
"props" : [
{
- "name" : "abbr",
+ "name" : "Label",
+ "type" : "String/Object",
+ "desc" : "for the strength meter (defaults to\n'Password strength:')",
+ "memberOf" : "Roo.bootstrap.form.SecurePass"
+ },
+ {
+ "name" : "accept",
"type" : "String",
- "desc" : "Specifies an abbreviated version of the content in a cell",
- "memberOf" : ""
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "align",
"type" : "String",
- "desc" : "Aligns the content in a cell",
- "memberOf" : ""
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
},
{
- "name" : "bgcolor",
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.Input"
},
{
"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",
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.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" : "Roo.bootstrap.form.SecurePass"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "focusClass",
"type" : "String",
- "desc" : "Specifies one or more header cells a cell is related to",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "Sets the height of a cell",
- "memberOf" : ""
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "hideMode",
"memberOf" : "Roo.Component"
},
{
- "name" : "html",
+ "name" : "indicatorpos",
"type" : "String",
- "desc" : "cell contain text",
- "memberOf" : ""
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
},
{
- "name" : "nowrap",
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.Input"
},
{
- "name" : "scope",
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minLengthText",
"type" : "String",
- "desc" : "Defines a way to associate header cells and data cells in a table",
- "memberOf" : ""
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "style",
+ "name" : "name",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
- "name" : "tag",
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "pwdStrengths",
+ "type" : "String/Object",
+ "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
+ "memberOf" : "Roo.bootstrap.form.SecurePass"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "cell tag (td|th) default td",
- "memberOf" : ""
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "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.form.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "visibilityEl",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "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.form.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.form.Input"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "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.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "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.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.TableRow" : {
+ "Roo.bootstrap.form.TextArea" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "desc" : "o) use for file input only. (default empty)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "align",
"type" : "String",
- "desc" : "Aligns the content in a table row",
- "memberOf" : ""
+ "desc" : "t) Default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "allowDomMove",
"memberOf" : "Roo.Component"
},
{
- "name" : "bgcolor",
+ "name" : "autocomplete",
"type" : "String",
- "desc" : "Specifies a background color for a table row",
- "memberOf" : ""
+ "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.Input"
},
{
"name" : "cls",
"type" : "String",
- "desc" : "row class",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "cols",
+ "type" : "Number",
+ "desc" : "Specifies the visible width of a text area",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
},
{
"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" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default false",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "desc" : "e) default true",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "html",
+ "type" : "string",
+ "desc" : "text",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default left",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "invalidText",
+ "type" : "String",
+ "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelWidth",
+ "type" : "Number",
+ "desc" : "set the width of label",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelmd",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "labelxs",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "memberOf" : "Roo.bootstrap.form.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.form.Input"
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "resize",
+ "type" : "string",
+ "desc" : "l)",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
+ },
+ {
+ "name" : "rows",
+ "type" : "Number",
+ "desc" : "Specifies the visible number of lines in a text area",
+ "memberOf" : "Roo.bootstrap.form.TextArea"
+ },
+ {
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for tablet-sized screens",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "style",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "valign",
+ "name" : "validClass",
"type" : "String",
- "desc" : "Vertical aligns the content in a table row",
- "memberOf" : ""
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validFeedbackIcon",
+ "type" : "String",
+ "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.bootstrap.form.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.form.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.form.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.form.Input"
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the input",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "visibilityEl",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.bootstrap.form.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" : "Roo.bootstrap.form.TextArea"
+ },
{
"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.form.Input"
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real textarea element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "reset",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "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.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.form.TextArea" : [
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.TextArea" : {
+ "Roo.bootstrap.form.TimeField" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "accept",
"type" : "String",
"desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "actionMode",
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "align",
"type" : "String",
"desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "allowDomMove",
"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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "can_build_overlaid",
"name" : "capture",
"type" : "String",
"desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "cls",
"desc" : "css class",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "cols",
- "type" : "Number",
- "desc" : "Specifies the visible width of a text area",
- "memberOf" : ""
- },
{
"name" : "container_method",
"type" : "string",
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "forceFeedback",
"type" : "Boolean",
"desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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" : "Roo.bootstrap.form.TimeField"
},
{
"name" : "hasFeedback",
"type" : "Boolean",
"desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "hideMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "html",
- "type" : "string",
- "desc" : "text",
- "memberOf" : ""
- },
{
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelAlign",
"type" : "String",
"desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "listeners",
"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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "resize",
- "type" : "string",
- "desc" : "l)",
- "memberOf" : ""
- },
- {
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "style",
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "visibilityEl",
"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" : ""
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "xattr",
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
}
],
"events" : [
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires just before the field blurs if the field value has changed.",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the user pastes into input",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"returns" : []
},
{
- "name" : "show",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.DateField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires when this field show.",
+ "sig" : "function (thisthis, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "thisthis",
+ "type" : "Roo.bootstrap.form.DateField",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
}
],
"returns" : []
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "inputEl",
"type" : "function",
- "desc" : "return the real textarea element.",
+ "desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.TimeField" : {
+ "Roo.bootstrap.form.TriggerField" : {
"props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
- },
{
"name" : "accept",
"type" : "String",
"desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "actionMode",
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "align",
"type" : "String",
"desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "allowDomMove",
"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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "can_build_overlaid",
"name" : "capture",
"type" : "String",
"desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "desc" : "r) BS3 only - carat fa name",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
},
{
"name" : "cls",
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "forceFeedback",
"type" : "Boolean",
"desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "format",
- "type" : "String",
- "desc" : "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "hasFeedback",
"type" : "Boolean",
"desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "hideMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
{
"name" : "indicatorpos",
"type" : "String",
"desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelAlign",
"type" : "String",
"desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "listeners",
"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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
+ },
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "desc" : "e) special filter default false",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "style",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "triggerClass",
+ "type" : "String",
+ "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
+ "memberOf" : "Roo.bootstrap.form.TriggerField"
+ },
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.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"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "visibilityEl",
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
},
{
"name" : "xattr",
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "memberOf" : "Roo.bootstrap.form.Input"
}
],
"events" : [
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires just before the field blurs if the field value has changed.",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the user pastes into input",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (thisthis, date)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "thisthis",
- "type" : "Roo.bootstrap.DateField",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
}
],
"returns" : []
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the name of the field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.form.TriggerField" : [
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.PhoneInput"
+ ],
+ "Roo.bootstrap.form.ComboBox" : [
+ "Roo.bootstrap.form.MoneyField"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.Tooltip" : {
+ "Roo.bootstrap.layout" : {
"props" : [],
"events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout.Basic" : {
+ "props" : [
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : "Roo.bootstrap.layout.Basic"
+ },
+ {
+ "name" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "memberOf" : "Roo.bootstrap.layout.Basic"
+ },
+ {
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "Roo.bootstrap.layout.Basic"
+ }
+ ],
+ "events" : [],
"methods" : [
{
- "name" : "currentEl",
+ "name" : "add",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : true,
+ "desc" : "Add the passed ContentPanel(s)",
+ "sig" : "(panel)",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- }
- ]
- },
- "Roo.bootstrap.TriggerField" : {
- "props" : [
- {
- "name" : "(button|checkbox|email|file|hidden|image|number|password|radio|range|reset|search|submit|text)",
- "type" : "String",
- "desc" : "inputType",
- "memberOf" : "Roo.bootstrap.Input"
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added)"
+ }
+ ]
},
{
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "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" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "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",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "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",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "getActivePanel",
+ "type" : "function",
+ "desc" : "Get the active panel for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
+ }
+ ]
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the container element for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "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" : "getPanel",
+ "type" : "function",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "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" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "can_build_overlaid",
- "type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "hasPanel",
+ "type" : "function",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this region is currently visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "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",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ },
+ {
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
+ }
+ ]
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "Show the specified panel.",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel or null"
+ }
+ ]
},
{
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "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",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.layout.Basic" : [
+ "Roo.bootstrap.layout.Region"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout.Border" : {
+ "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.bootstrap.Input"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "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" : "hasFeedback",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
{
- "name" : "hideTrigger",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : ""
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "center",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in center",
+ "memberOf" : "Roo.bootstrap.layout.Border"
},
{
- "name" : "invalidClass",
+ "name" : "cls",
"type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
+ "desc" : "css class",
+ "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" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "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" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "labelAlign",
+ "name" : "disableClass",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.Input"
+ "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" : "east",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in east",
+ "memberOf" : "Roo.bootstrap.layout.Border"
},
{
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
"name" : "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" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : ""
- },
- {
- "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",
+ "desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : ""
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "north",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in north",
+ "memberOf" : "Roo.bootstrap.layout.Border"
},
{
- "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" : "south",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in south",
+ "memberOf" : "Roo.bootstrap.layout.Border"
},
{
- "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" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "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",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.Input"
+ "name" : "west",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in west",
+ "memberOf" : "Roo.bootstrap.layout.Border"
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
"memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.Input"
}
],
"events" : [
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
"returns" : []
},
{
- "name" : "focus",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires when a layout is performed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutManager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The collapsed region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The expanded region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paste",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The resized region",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "specialkey",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
+ "desc" : "Adds a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel to add",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The added panel"
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "autoSize",
+ "name" : "addRegion",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "Creates and adds a new region if it doesn't already exist.",
+ "sig" : "(target, config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The regions config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BorderLayoutRegion",
+ "desc" : "The new region"
+ }
+ ]
+ },
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beginUpdate",
+ "type" : "function",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [],
"returns" : []
},
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "enable",
"type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
]
},
{
- "name" : "enable",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "noLayout",
+ "type" : "Boolean",
+ "desc" : "true to disable a layout update",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "findPanel",
+ "type" : "function",
+ "desc" : "Searches all regions for a panel with the specified id",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel or null if it wasn't found"
}
]
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : ""
}
]
},
]
},
{
- "name" : "getName",
+ "name" : "getRegion",
"type" : "function",
- "desc" : "Returns the name of the field",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.LayoutRegion",
+ "desc" : ""
}
]
},
{
- "name" : "getValue",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
}
]
},
"returns" : []
},
{
- "name" : "inputEl",
+ "name" : "isUpdating",
"type" : "function",
- "desc" : "return the real input element.",
+ "desc" : "Returns true if this layout is currently being updated",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "isVisible",
"returns" : []
},
{
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
+ "name" : "layout",
"type" : "function",
- "desc" : "Mark this field as valid",
+ "desc" : "Performs a layout update.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Remove a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Number/String/Roo.ContentPanel",
+ "desc" : "The index, id or panel to remove",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The removed panel"
+ }
+ ]
+ },
{
"name" : "removeListener",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setValue",
+ "name" : "setVisible",
"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" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Input",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setVisibilityEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Show a component - removes 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.bootstrap.Component",
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "panelId",
+ "type" : "String/ContentPanel",
+ "desc" : "The panels id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel or null"
}
]
},
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "tooltipEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : true,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.panel.Content",
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Grid"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.UploadCropbox" : {
+ "Roo.bootstrap.layout.Manager" : {
"props" : [
{
"name" : "actionMode",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
- {
- "name" : "buttons",
- "type" : "Array",
- "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
- "memberOf" : ""
- },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "show when image has been loaded",
- "memberOf" : ""
- },
- {
- "name" : "errorTimeout",
- "type" : "Number",
- "desc" : "default 3000",
- "memberOf" : ""
- },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "isDocument",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
- },
- {
- "name" : "loadingText",
- "type" : "Boolean",
- "desc" : "default 'Loading...'",
- "memberOf" : ""
- },
- {
- "name" : "method",
- "type" : "String",
- "desc" : "default POST",
- "memberOf" : ""
- },
- {
- "name" : "minHeight",
- "type" : "Number",
- "desc" : "default 300",
- "memberOf" : ""
- },
- {
- "name" : "minWidth",
- "type" : "Number",
- "desc" : "default 300",
- "memberOf" : ""
- },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "paramName",
- "type" : "String",
- "desc" : "default 'imageUpload'",
- "memberOf" : ""
- },
- {
- "name" : "rotateNotify",
- "type" : "String",
- "desc" : "show when image too small to rotate",
- "memberOf" : ""
- },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "url",
- "type" : "String",
- "desc" : "action url",
- "memberOf" : ""
- },
{
"name" : "visibilityEl",
"type" : "string|object",
}
],
"events" : [
- {
- "name" : "arrange",
- "type" : "function",
- "desc" : "Fire when arrange the file data",
- "sig" : "function (_self, formData)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "formData",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeloadcanvas",
- "type" : "function",
- "desc" : "Fire before load the canvas",
- "sig" : "function (_self, src)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "src",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselectfile",
- "type" : "function",
- "desc" : "Fire before select file",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "crop",
- "type" : "function",
- "desc" : "Fire after initEvent",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "download",
- "type" : "function",
- "desc" : "Fire when download the image",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "exception",
- "type" : "function",
- "desc" : "Fire when get exception",
- "sig" : "function (_self, xhr)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "xhr",
- "type" : "XMLHttpRequest",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "footerbuttonclick",
- "type" : "function",
- "desc" : "Fire when footerbuttonclick",
- "sig" : "function (_self, type)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
"returns" : []
},
{
- "name" : "initial",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fire after initEvent",
+ "desc" : "Fires when a layout is performed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "inspect",
- "type" : "function",
- "desc" : "Fire when inspect the file",
- "sig" : "function (_self, file)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
+ "type" : "Roo.LayoutManager",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "prepare",
+ "name" : "regioncollapsed",
"type" : "function",
- "desc" : "Fire when preparing the file data",
- "sig" : "function (_self, file)\n{\n\n}",
+ "desc" : "Fires when a region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "file",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The collapsed region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "regionexpanded",
"type" : "function",
- "desc" : "Fire when resize",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The expanded region",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rotate",
+ "name" : "regionresized",
"type" : "function",
- "desc" : "Fire when rotate the image",
- "sig" : "function (_self, pos)\n{\n\n}",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The resized region",
"isOptional" : false
},
{
- "name" : "pos",
- "type" : "String",
- "desc" : "",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "trash",
+ "name" : "show",
"type" : "function",
- "desc" : "Fire when trash image",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "upload",
- "type" : "function",
- "desc" : "Fire when xhr upload the file",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.UploadCropbox",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "beginUpdate",
+ "type" : "function",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
}
]
},
+ {
+ "name" : "endUpdate",
+ "type" : "function",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "noLayout",
+ "type" : "Boolean",
+ "desc" : "true to disable a layout update",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "The element"
+ "desc" : ""
}
]
},
}
]
},
+ {
+ "name" : "getRegion",
+ "type" : "function",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.LayoutRegion",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getViewSize",
+ "type" : "function",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "isUpdating",
+ "type" : "function",
+ "desc" : "Returns true if this layout is currently being updated",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
],
"returns" : []
}
- ]
- },
- "Roo.bootstrap.breadcrumb" : {
- "props" : [],
- "events" : [],
- "methods" : []
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.layout.Manager" : [
+ "Roo.bootstrap.layout.Border"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.breadcrumb.Item" : {
+ "Roo.bootstrap.layout.Region" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "name" : "alwaysShowTabs",
+ "type" : "Boolean",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "active",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "is it active",
- "memberOf" : ""
+ "desc" : "True to animate expand/collapse (defaults to false)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "allowDomMove",
+ "name" : "autoHide",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "can_build_overlaid",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "True to enable overflow scrolling (defaults to false)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "closeOnTab",
+ "type" : "Boolean",
+ "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "container_method",
+ "name" : "cls",
"type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "Extra CSS classes to add to region",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "cmargins",
+ "type" : "Object",
+ "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "where it links to if '#' is used the link will be handled by onClick.",
- "memberOf" : ""
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "the content of the link.",
- "memberOf" : ""
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
+ },
+ {
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "overflow",
+ "type" : "String",
+ "desc" : "e) if you have menus in the region, then you need to set this to visible.",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "resizeTabs",
+ "type" : "Boolean",
+ "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "childrenrendered",
- "type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "Roo.bootstrap.layout.Basic"
},
{
- "name" : "click",
- "type" : "function",
- "desc" : "The img click event for the img.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "tabPosition",
+ "type" : "String",
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "Roo.bootstrap.layout.Region"
},
{
- "name" : "render",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "Roo.bootstrap.layout.Region"
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "add",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added; null otherwise)"
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "animateCollapse",
+ "type" : "function",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "animateExpand",
+ "type" : "function",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
+ "isOptional" : false
+ },
+ {
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "enable",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Get the active panel for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "title",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns the container element for this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.TabPanel",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "hasListener",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : ""
}
]
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
}
]
},
}
],
"returns" : []
+ },
+ {
+ "name" : "unhidePanel",
+ "type" : "function",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.breadcrumb.Nav" : {
+ "Roo.bootstrap.layout.Split" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "name" : "alwaysShowTabs",
+ "type" : "Boolean",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "allowDomMove",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "True to animate expand/collapse (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "can_build_overlaid",
+ "name" : "autoHide",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "closeOnTab",
+ "type" : "Boolean",
+ "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "cmargins",
+ "type" : "Object",
+ "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "name" : "collapsed",
+ "type" : "Boolean",
+ "desc" : "True to set the initial display to collapsed (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "hideMode",
+ "name" : "collapsedTitle",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "collapsible",
+ "type" : "Boolean",
+ "desc" : "False to disable collapsing (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "floatable",
+ "type" : "Boolean",
+ "desc" : "False to disable floating (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "memberOf" : "Roo.LayoutRegion"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "style",
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "resizeTabs",
+ "type" : "Boolean",
+ "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "showPin",
+ "type" : "Boolean",
+ "desc" : "True to show a pin button",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "tabPosition",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion"
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "Roo.LayoutRegion"
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "Roo.LayoutRegion"
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "beforecollapse",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires when this region before collapse.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
+ "sig" : "function (_self, panel, e)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The cancel event object",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "collapsed",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires when this region is collapsed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "expanded",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this region is expanded.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "invalidated",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when the layout for this region is changed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "panelactivated",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a panel is activated.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The activated panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "paneladded",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a panel is added.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "panelremoved",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a panel is removed.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "resized",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the user resizes this region.",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "slidehide",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires when this region slides out of view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "show",
+ "name" : "slideshow",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires when this region is slid into view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "visibilitychange",
+ "type" : "function",
+ "desc" : "Fires when this region is shown or hidden",
+ "sig" : "function (_self, visibility)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "visibility",
+ "type" : "Boolean",
+ "desc" : "true or false",
+ "isOptional" : false
}
],
"returns" : []
}
],
"methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added; null otherwise)"
+ }
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "expand",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
+ "isOptional" : false
+ },
+ {
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "fireEvent",
]
},
{
- "name" : "focus",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Get the active panel for this region.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns the container element for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.BasicLayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getSplitBar",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the {@link Roo.SplitBar} for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.SplitBar",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns the TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanel",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "hasListener",
}
]
},
+ {
+ "name" : "hasPanel",
+ "type" : "function",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.BasicLayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "initEvents",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Initialize Events for the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
],
"returns" : []
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ },
+ {
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
+ }
+ ]
+ },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setCollapsedTitle",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
}
]
},
}
],
"returns" : []
+ },
+ {
+ "name" : "unhidePanel",
+ "type" : "function",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.dash" : {
+ "Roo.bootstrap.menu" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.dash.NumberBox" : {
+ "Roo.bootstrap.menu.Item" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "used on sidebars to highlight active itesm",
+ "memberOf" : "Roo.bootstrap.menu.Item"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Box content",
- "memberOf" : ""
- },
{
"name" : "dataId",
"type" : "string",
"memberOf" : "Roo.Component"
},
{
- "name" : "fhref",
+ "name" : "fa",
"type" : "String",
- "desc" : "Footer href",
- "memberOf" : ""
+ "desc" : "favicon to show on left of menu item.",
+ "memberOf" : "Roo.bootstrap.menu.Item"
},
{
- "name" : "footer",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "Footer text",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "headline",
+ "name" : "href",
"type" : "String",
- "desc" : "Box headline",
- "memberOf" : ""
+ "desc" : "the link",
+ "memberOf" : "Roo.bootstrap.menu.Item"
},
{
- "name" : "hideMode",
+ "name" : "html",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "the menu label",
+ "memberOf" : "Roo.bootstrap.menu.Item"
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "Box icon",
- "memberOf" : ""
+ "name" : "isContainer",
+ "type" : "Boolean",
+ "desc" : "is it a container - just returns a drop down item..",
+ "memberOf" : "Roo.bootstrap.menu.Item"
},
{
"name" : "listeners",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "menu",
+ "type" : "Roo.bootsrap.Menu",
+ "desc" : "the child menu.",
+ "memberOf" : "Roo.bootstrap.menu.Item"
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "do not trigger A href on clicks (default false).",
+ "memberOf" : "Roo.bootstrap.menu.Item"
+ },
{
"name" : "style",
"type" : "String",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.menu.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Container"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.menu.Menu"
]
},
- "Roo.bootstrap.dash.TabBox" : {
+ "Roo.bootstrap.menu.Manager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "Returns a {@link Roo.menu.Menu} object",
+ "sig" : "(menu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "menu",
+ "type" : "String/Object",
+ "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hideAll",
+ "type" : "function",
+ "desc" : "Hides all menus that are currently visible",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.menu.Menu" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "default tl-bl? == below - how the menu should be aligned.",
+ "memberOf" : "Roo.bootstrap.menu.Menu"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "hidden",
+ "type" : "bool",
+ "desc" : "if the menu should be hidden when rendered.",
+ "memberOf" : "Roo.bootstrap.menu.Menu"
+ },
{
"name" : "hideMode",
"type" : "String",
"memberOf" : "Roo.Component"
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "Icon of the TabBox",
- "memberOf" : ""
+ "name" : "hideTrigger",
+ "type" : "bool",
+ "desc" : "e) default false - hide the carret for trigger.",
+ "memberOf" : "Roo.bootstrap.menu.Menu"
+ },
+ {
+ "name" : "isLink",
+ "type" : "bool",
+ "desc" : "e) the menu has link disable auto expand and collaspe (default false)",
+ "memberOf" : "Roo.bootstrap.menu.Menu"
},
{
"name" : "listeners",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "showtabs",
+ "name" : "registerMenu",
"type" : "Boolean",
- "desc" : "e) show the tabs default true",
- "memberOf" : ""
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf" : "Roo.bootstrap.menu.Menu"
+ },
+ {
+ "name" : "stopEvent",
+ "type" : "bool",
+ "desc" : "e) Stop event after trigger press (default true)",
+ "memberOf" : "Roo.bootstrap.menu.Menu"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "tabScrollable",
- "type" : "Boolean",
- "desc" : "e) tab scrollable when mobile view default false",
- "memberOf" : ""
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "Title of the TabBox",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "u) type of menu",
+ "memberOf" : "Roo.bootstrap.menu.Menu"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
}
],
"events" : [
- {
- "name" : "activatepane",
- "type" : "function",
- "desc" : "When a pane is activated",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "pane",
- "type" : "Roo.bootstrap.dash.TabPane",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addpane",
- "type" : "function",
- "desc" : "When a pane is added",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "pane",
- "type" : "Roo.bootstrap.dash.TabPane",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "desc" : "Fires before this menu is hidden (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires before this menu is displayed (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
+ "sig" : "function (_self, menuItem, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after this menu is hidden",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "itemclick",
+ "type" : "function",
+ "desc" : "Fires when a menu item contained in this menu is clicked",
+ "sig" : "function (baseItem, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "baseItem",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "The BaseItem that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseout",
+ "type" : "function",
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after this menu is displayed",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
{
"name" : "hide",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
},
- {
- "name" : "setTitle",
- "type" : "function",
- "desc" : "Updates the box title",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "String",
- "desc" : "to set the title to.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
{
"name" : "show",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "showAt",
+ "type" : "function",
+ "desc" : "Displays this menu at a specific xy position",
+ "sig" : "(xyPosition, parentMenu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "xyPosition",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.menu.Item"
+ ],
+ "tree_parent" : [
+ "none"
]
},
- "Roo.bootstrap.dash.TabPane" : {
+ "Roo.bootstrap.menu.Separator" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : ""
- },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "title",
- "type" : "String",
- "desc" : "title of panel",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
}
],
"events" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "When a pane is activated",
- "sig" : "function (pane)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "pane",
- "type" : "Roo.bootstrap.dash.TabPane",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : [
+ "Roo.bootstrap.menu.Menu"
+ ]
+ },
+ "Roo.bootstrap.nav" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.nav.Bar" : {
+ "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" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Updates the tab title",
- "sig" : "(html)",
- "static" : false,
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "String",
- "desc" : "to set the title to.",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "disable",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "hide",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.htmleditor" : {
- "props" : [],
- "events" : [],
- "methods" : []
- },
- "Roo.bootstrap.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; }",
- "memberOf" : ""
},
{
- "name" : "disable",
- "type" : "Object",
- "desc" : "List of elements to disable..",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "updateToolbar",
+ "name" : "render",
"type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ]
- },
- "Roo.bootstrap.layout" : {
- "props" : [],
- "events" : [],
- "methods" : []
- },
- "Roo.bootstrap.layout.Basic" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : ""
- },
- {
- "name" : "region",
- "type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : ""
},
{
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "add",
+ "name" : "show",
"type" : "function",
- "desc" : "Add the passed ContentPanel(s)",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added)"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getPanel",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
]
},
{
- "name" : "hasPanel",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Show the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.nav.Bar" : [
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "Roo.bootstrap.nav.Simplebar" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.nav.Headerbar"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.layout.Border" : {
+ "Roo.bootstrap.nav.Group" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t)",
+ "memberOf" : "Roo.bootstrap.nav.Group"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Group"
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "navId",
+ "type" : "String",
+ "desc" : "- reference Id for navbar.",
+ "memberOf" : "Roo.bootstrap.nav.Group"
+ },
+ {
+ "name" : "pilltype",
+ "type" : "Boolean",
+ "desc" : "default true (turn to off to disable active toggle)",
+ "memberOf" : "Roo.bootstrap.nav.Group"
+ },
{
"name" : "style",
"type" : "String",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "b) default nav",
+ "memberOf" : "Roo.bootstrap.nav.Group"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.bootstrap.nav.Group",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "selected",
+ "type" : "Roo.bootstrap.Navbar.Item",
+ "desc" : "The item selected",
+ "isOptional" : false
+ },
+ {
+ "name" : "prev",
+ "type" : "Roo.bootstrap.Navbar.Item",
+ "desc" : "The previously selected item",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "layout",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutManager",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "regioncollapsed",
- "type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionexpanded",
- "type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionresized",
- "type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"methods" : [
{
- "name" : "add",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Adds a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel to add",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The added panel"
- }
- ]
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "addItem",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "adds a Navigation item",
+ "sig" : "(the)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addRegion",
+ "name" : "capture",
"type" : "function",
- "desc" : "Creates and adds a new region if it doesn't already exist.",
- "sig" : "(target, config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "Object",
- "desc" : "The regions config object",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BorderLayoutRegion",
- "desc" : "The new region"
- }
- ]
- },
- {
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "cfg",
+ "name" : "scope",
"type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beginUpdate",
+ "name" : "clearAll",
"type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "desc" : "clear all the Navigation item",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "endUpdate",
- "type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "findPanel",
- "type" : "function",
- "desc" : "Searches all regions for a panel with the specified id",
- "sig" : "(panelId)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panelId",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel or null if it wasn't found"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getChildContainer",
+ "name" : "get",
"type" : "function",
- "desc" : "Fetch the element to add children to",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
+ "desc" : "fetch a Navigation Group based on the navigation ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "the",
+ "type" : "string",
+ "desc" : "navgroup to add",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "getActive",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "gets the active Navigation item",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "the current navitem"
}
]
},
{
- "name" : "getId",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getRegion",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getViewSize",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
+ "type" : "String",
+ "desc" : ""
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "isUpdating",
- "type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "layout",
- "type" : "function",
- "desc" : "Performs a layout update.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "register",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "register a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "register",
"type" : "function",
- "desc" : "Remove a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
- "static" : false,
+ "desc" : "register a Navigation Group",
+ "sig" : "(the)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
- "isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Number/String/Roo.ContentPanel",
- "desc" : "The index, id or panel to remove",
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Group",
+ "desc" : "navgroup to add",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The removed panel"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "removeListener",
],
"returns" : []
},
+ {
+ "name" : "setActiveItem",
+ "type" : "function",
+ "desc" : "sets the active Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "new current navitem",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "showPanel",
- "type" : "function",
- "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
- "sig" : "(panelId)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panelId",
- "type" : "String/ContentPanel",
- "desc" : "The panels id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
- }
- ]
- },
{
"name" : "tooltipEl",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.SidebarItem"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.layout.Manager" : {
+ "Roo.bootstrap.nav.Headerbar" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "arrangement",
+ "type" : "Boolean",
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "autohide",
+ "type" : "Boolean",
+ "desc" : "a top nav bar header that hides on scroll.",
+ "memberOf" : "Roo.bootstrap.nav.Headerbar"
+ },
+ {
+ "name" : "brand",
+ "type" : "String",
+ "desc" : "what is brand",
+ "memberOf" : "Roo.bootstrap.nav.Headerbar"
+ },
+ {
+ "name" : "brand_href",
+ "type" : "String",
+ "desc" : "href of the brand",
+ "memberOf" : "Roo.bootstrap.nav.Headerbar"
+ },
{
"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" : "Roo.bootstrap.nav.Headerbar"
+ },
{
"name" : "disableClass",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "inverse",
+ "type" : "Boolean",
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
},
+ {
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "mobilerow",
+ "type" : "Roo.bootstrap.Row",
+ "desc" : "- a row to display on mobile only..",
+ "memberOf" : "Roo.bootstrap.nav.Headerbar"
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "p) position",
+ "memberOf" : "Roo.bootstrap.nav.Headerbar"
+ },
+ {
+ "name" : "srButton",
+ "type" : "Boolean",
+ "desc" : "generate the (screen reader / mobile) sr-only button default true",
+ "memberOf" : "Roo.bootstrap.nav.Headerbar"
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "visibilityEl",
"type" : "string|object",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "weight",
+ "type" : "String",
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
{
"name" : "xattr",
"type" : "Object",
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "enable",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "hide",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
+ "desc" : "Fires after the component is enabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "layout",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutManager",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "regioncollapsed",
- "type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionexpanded",
- "type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regionresized",
- "type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "region",
- "type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beginUpdate",
- "type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
]
},
{
- "name" : "endUpdate",
+ "name" : "expand",
"type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "noLayout",
- "type" : "Boolean",
- "desc" : "true to disable a layout update",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
+ "desc" : "The element"
}
]
},
}
]
},
- {
- "name" : "getRegion",
- "type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.LayoutRegion",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getViewSize",
- "type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "isUpdating",
- "type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.layout.Region" : {
+ "Roo.bootstrap.nav.Item" : {
"props" : [
{
- "name" : "alwaysShowTabs",
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "active",
"type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : ""
+ "desc" : "Is item active",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "animate",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : ""
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "autoHide",
+ "name" : "animateRef",
"type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : ""
+ "desc" : "e) link to element default false",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "autoScroll",
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "badgecls",
+ "type" : "String",
+ "desc" : "w)the extra classes for the badge",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "button_outline",
"type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : ""
+ "desc" : "show and outlined button",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "closeOnTab",
+ "name" : "button_weight",
+ "type" : "String",
+ "desc" : "k) default none",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : ""
+ "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" : "Extra CSS classes to add to region",
- "memberOf" : ""
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "cmargins",
- "type" : "Object",
- "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : ""
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "disableTabTips",
+ "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 tab tooltips",
- "memberOf" : ""
+ "desc" : "Is item disabled",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : ""
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : ""
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (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"
},
{
- "name" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : ""
+ "name" : "href",
+ "type" : "String",
+ "desc" : "link to",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of button",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "linkcls",
+ "type" : "String",
+ "desc" : "Link Class",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : ""
+ "name" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : ""
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : ""
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "overflow",
+ "name" : "style",
"type" : "String",
- "desc" : "e) if you have menus in the region, then you need to set this to visible.",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : ""
+ "name" : "tabId",
+ "type" : "String",
+ "desc" : "the tab that this item activates.",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : ""
+ "name" : "tagtype",
+ "type" : "String",
+ "desc" : "n) render as a href or span?",
+ "memberOf" : "Roo.bootstrap.nav.Item"
},
{
- "name" : "region",
+ "name" : "tooltip",
"type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : ""
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "resizeTabs",
- "type" : "Boolean",
- "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : ""
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : "Roo.bootstrap.layout.Basic"
- },
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
+ }
+ ],
+ "events" : [
{
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "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",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tabPosition",
- "type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : ""
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : ""
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : ""
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : ""
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
- "name" : "add",
+ "name" : "click",
"type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "disable",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "enable",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "scrollto",
+ "type" : "function",
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "animateCollapse",
+ "name" : "show",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "animateExpand",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getActivePanel",
+ "name" : "disable",
"type" : "function",
- "desc" : "Get the active panel for this region.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getBox",
+ "name" : "enable",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getEl",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the container element for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getPanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getTabs",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanel",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "hasPanel",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hidePanel",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "removeListener",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "setHtml",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "Set the HTML (text content) of the item",
+ "sig" : "(html)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "html",
+ "type" : "string",
+ "desc" : "content for the nav item",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
- {
- "name" : "unhidePanel",
- "type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
}
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.nav.Item" : [
+ "Roo.bootstrap.nav.SidebarItem"
+ ]
+ },
+ "tree_children" : [
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.nav.Group"
]
},
- "Roo.bootstrap.layout.Split" : {
+ "Roo.bootstrap.nav.ProgressBar" : {
"props" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "autoHide",
- "type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "closeOnTab",
- "type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "cmargins",
- "type" : "Object",
- "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "collapsed",
- "type" : "Boolean",
- "desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "NavProgressBar:bullets[]",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "Bullets for the Nav Progress bar for the toolbar",
+ "memberOf" : "Roo.bootstrap.nav.ProgressBar"
},
{
- "name" : "collapsedTitle",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "collapsible",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "disableTabTips",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "floatable",
- "type" : "Boolean",
- "desc" : "False to disable floating (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "For North/South panels",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "resizeTabs",
- "type" : "Boolean",
- "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "showPin",
- "type" : "Boolean",
- "desc" : "True to show a pin button",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "tabPosition",
- "type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "title",
+ "name" : "style",
"type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
}
],
"events" : [
{
- "name" : "beforecollapse",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this region before collapse.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
- "sig" : "function (_self, panel, e)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The cancel event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collapsed",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this region is collapsed.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "expanded",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when this region is expanded.",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalidated",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fires when the layout for this region is changed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.bootstrap.nav.ProgressBar",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "selected",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "The item selected",
+ "isOptional" : false
+ },
+ {
+ "name" : "prev",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "The previously selected item",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "panelactivated",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when a panel is activated.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The activated panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paneladded",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when a panel is added.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "panelremoved",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when a panel is removed.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resized",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the user resizes this region.",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "slidehide",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when this region slides out of view.",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "slideshow",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when this region is slid into view.",
+ "desc" : "Fires after the component is rendered.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "visibilitychange",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when this region is shown or hidden",
- "sig" : "function (_self, visibility)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "visibility",
- "type" : "Boolean",
- "desc" : "true or false",
- "isOptional" : false
}
],
"returns" : []
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
- }
- ]
- },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "expand",
+ "name" : "disable",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getPanel",
- "type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getSplitBar",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the {@link Roo.SplitBar} for this region.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.SplitBar",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "getTabs",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanel",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "hasListener",
}
]
},
- {
- "name" : "hasPanel",
- "type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hidePanel",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
],
"returns" : []
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- },
- {
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
- }
- ]
- },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "render",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setCollapsedTitle",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
- {
- "name" : "unhidePanel",
- "type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
}
- ]
- },
- "Roo.bootstrap.menu" : {
- "props" : [],
- "events" : [],
- "methods" : []
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.nav.ProgressBarItem"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.menu.Item" : {
+ "Roo.bootstrap.nav.ProgressBarItem" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "e) Is item active default false",
+ "memberOf" : "Roo.bootstrap.nav.ProgressBarItem"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "cutomer id",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "disable",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "e) Is item active default false",
+ "memberOf" : "Roo.bootstrap.nav.ProgressBarItem"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
- "memberOf" : ""
- },
{
"name" : "html",
"type" : "String",
- "desc" : "text of the item",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.ProgressBarItem"
},
{
"name" : "icon",
"type" : "String",
- "desc" : "Font awesome icon",
- "memberOf" : ""
+ "desc" : "show icon instead of number",
+ "memberOf" : "Roo.bootstrap.nav.ProgressBarItem"
},
{
"name" : "listeners",
"memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "pos",
+ "name" : "position",
"type" : "String",
- "desc" : "Submenu align to (left | right) default right",
- "memberOf" : ""
+ "desc" : "m) text position default bottom",
+ "memberOf" : "Roo.bootstrap.nav.ProgressBarItem"
},
{
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
+ "name" : "rid",
+ "type" : "String",
+ "desc" : "the reference id",
+ "memberOf" : "Roo.bootstrap.nav.ProgressBarItem"
},
{
"name" : "style",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "submenu",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
- },
{
"name" : "tooltip",
"type" : "string",
"name" : "click",
"type" : "function",
"desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.ProgressBarItem",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "e",
"type" : "Roo.EventObject",
],
"returns" : []
},
- {
- "name" : "mouseout",
- "type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.menu.Item",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseover",
- "type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.menu.Item",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.menu.Menu" : {
+ "Roo.bootstrap.nav.Sidebar" : {
"props" : [
{
"name" : "actionMode",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
- {
- "name" : "html",
- "type" : "String",
- "desc" : "Text of the menu",
- "memberOf" : ""
- },
- {
- "name" : "icon",
- "type" : "String",
- "desc" : "Font awesome icon",
- "memberOf" : ""
- },
{
"name" : "listeners",
"type" : "Object",
"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",
"desc" : "t) What element to use for visibility (@see getVisibilityEl())",
"memberOf" : "Roo.bootstrap.Component"
},
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "e)",
- "memberOf" : ""
- },
{
"name" : "xattr",
"type" : "Object",
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before this menu is hidden",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before this menu is displayed",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "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" : "",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after this menu is displayed",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.menu.Separator" : {
+ "Roo.bootstrap.nav.SidebarItem" : {
"props" : [
{
"name" : "actionMode",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "Is item active",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "animateRef",
+ "type" : "Boolean",
+ "desc" : "e) link to element default false",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "badgecls",
+ "type" : "String",
+ "desc" : "w)the extra classes for the badge",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "button_outline",
+ "type" : "Boolean",
+ "desc" : "show and outlined button",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "button_weight",
+ "type" : "String",
+ "desc" : "k) default none",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "Is item disabled",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "hideMode",
"type" : "String",
"desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
"memberOf" : "Roo.Component"
},
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "link to",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of button",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "linkcls",
+ "type" : "String",
+ "desc" : "Link Class",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"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" : "menu",
+ "type" : "Roo.bootstrap.menu.Menu",
+ "desc" : "a Menu",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default false",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
"memberOf" : "Roo.bootstrap.Component"
},
+ {
+ "name" : "tabId",
+ "type" : "String",
+ "desc" : "the tab that this item activates.",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
+ {
+ "name" : "tagtype",
+ "type" : "String",
+ "desc" : "n) render as a href or span?",
+ "memberOf" : "Roo.bootstrap.nav.Item"
+ },
{
"name" : "tooltip",
"type" : "string",
],
"returns" : []
},
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.SidebarItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "scrollto",
+ "type" : "function",
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setHtml",
+ "type" : "function",
+ "desc" : "Set the HTML (text content) of the item",
+ "sig" : "(html)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "html",
+ "type" : "string",
+ "desc" : "content for the nav item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
}
- ]
- },
- "Roo.bootstrap.panel" : {
- "props" : [],
- "events" : [],
- "methods" : []
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.panel.Content" : {
+ "Roo.bootstrap.nav.Simplebar" : {
"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" : "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" : "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",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : ""
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "name" : "background",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : ""
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "badges",
+ "name" : "arrangement",
"type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : ""
+ "desc" : "stacked | justified",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "name" : "closable",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : ""
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
"name" : "cls",
"type" : "String",
- "desc" : "extra classes to use",
- "memberOf" : ""
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : ""
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "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" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.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" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
},
{
- "name" : "iframe",
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "inverse",
"type" : "Boolean",
- "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : ""
+ "desc" : "is inverted color",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
"name" : "listeners",
"memberOf" : "Roo.util.Observable"
},
{
- "name" : "loadOnce",
+ "name" : "loadMask",
"type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "desc" : "e) loadMask on the bar",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "name" : "main",
+ "type" : "Boolean",
+ "desc" : "e) main nav bar? default false",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "name" : "region",
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "style",
"type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : ""
+ "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" : ""
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "v) default is nav",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "name" : "title",
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component"
+ },
+ {
+ "name" : "type",
"type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : ""
+ "desc" : "s)",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
},
{
- "name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : ""
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
+ "memberOf" : "Roo.bootstrap.Component"
},
{
- "name" : "url",
+ "name" : "weight",
"type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "desc" : "e) default is light.",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component"
}
],
"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" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "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" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "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" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "resize",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\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",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforetoggle",
+ "type" : "function",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "scroll",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when this content is scrolled",
- "sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "scrollEvent",
- "type" : "Event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this 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",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getChildContainer",
+ "name" : "focus",
"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" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getId",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns this panel's id",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
- }
- ]
+ "returns" : []
},
{
"name" : "hasListener",
]
},
{
- "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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "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}.\nDoes not work with IFRAME contents",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "render",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "refresh",
+ "name" : "setDisabled",
"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}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Updates this panel's element (not for iframe)",
- "sig" : "(content, loadScripts)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
- "type" : "String",
- "desc" : "The new content",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
+ "name" : "visible",
"type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setTitle",
+ "name" : "show",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "title",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setUrl",
+ "name" : "tooltipEl",
"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" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
- "isOptional" : false
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager|Boolean",
- "desc" : "The UpdateManager or false if IFRAME"
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.nav.Simplebar" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.nav.Headerbar"
+ ]
+ },
+ "tree_children" : [
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.panel.Grid" : {
+ "Roo.bootstrap.panel" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.panel.Content" : {
"props" : [
{
"name" : "adjustments",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
"memberOf" : "Roo.bootstrap.panel.Content"
},
- {
- "name" : "grid",
- "type" : "Roo.bootstrap.Table",
- "desc" : "The grid for this panel",
- "memberOf" : ""
- },
{
"name" : "iframe",
"type" : "Boolean",
"type" : "function",
"desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this panel is resized if fitToFrame is true.",
"sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this content is scrolled",
"sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
"sig" : "(cfg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns this panel's element - used by regiosn to add.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getGrid",
- "type" : "function",
- "desc" : "Returns the grid for this panel",
- "sig" : "()\n{\n\n}",
- "static" : false,
"memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.bootstrap.Table",
+ "type" : "Roo.Element",
"desc" : ""
}
]
"desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns this panel's title",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
"sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Updates this panel's element (not for iframe)",
"sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Set this panel's title",
"sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
"sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : true,
+ "childClasses" : {
+ "Roo.bootstrap.panel.Content" : [
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest"
+ ]
+ },
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : []
},
- "Roo.bootstrap.panel.Nest" : {
+ "Roo.bootstrap.panel.Grid" : {
"props" : [
{
"name" : "adjustments",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
"memberOf" : "Roo.bootstrap.panel.Content"
},
+ {
+ "name" : "grid",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "The grid for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Grid"
+ },
{
"name" : "iframe",
"type" : "Boolean",
},
{
"name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "type" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "the toolbar at the top of the grid.",
+ "memberOf" : "Roo.bootstrap.panel.Grid"
},
{
"name" : "url",
],
"returns" : []
},
- {
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
]
},
{
- "name" : "getId",
+ "name" : "getGrid",
"type" : "function",
- "desc" : "Returns this panel's id",
+ "desc" : "Returns the grid for this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.bootstrap.Table",
"desc" : ""
}
]
},
{
- "name" : "getLayout",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the nested BorderLayout for this panel",
+ "desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.BorderLayout",
+ "type" : "String",
"desc" : ""
}
]
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.panel.TabItem" : {
+ "Roo.bootstrap.panel.Nest" : {
"props" : [
+ {
+ "name" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "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" : "cls",
+ "type" : "String",
+ "desc" : "extra classes to use",
+ "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" : "iframe",
+ "type" : "Boolean",
+ "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "layout",
+ "type" : "Roo.BorderLayout",
+ "desc" : "The layout for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Nest"
+ },
{
"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" : "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" : "region",
+ "type" : "String",
+ "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.bootstrap.panel.Content"
+ },
+ {
+ "name" : "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"
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content"
}
],
"events" : [
{
"name" : "activate",
"type" : "function",
- "desc" : "Fires when this tab becomes the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Roo.TabPanelItem",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeclose",
+ "name" : "deactivate",
"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 when this panel is activated.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.TabPanelItem",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the close.",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "close",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when this tab is closed.",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.TabPanelItem",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires when this tab is no longer the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
+ "name" : "this",
+ "type" : "Roo.ContentPanel",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "activate",
+ "name" : "scroll",
"type" : "function",
- "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this content is scrolled",
+ "sig" : "function (_self, scrollEvent)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.ContentPanel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollEvent",
+ "type" : "Event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "disable",
- "type" : "function",
- "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "enable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Enables this TabPanelItem if it was previously disabled.",
+ "desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getText",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the text for this tab",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns this panel's id",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getUpdateManager",
+ "name" : "getLayout",
"type" : "function",
- "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
+ "desc" : "Returns the nested BorderLayout for this panel",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Roo.BorderLayout",
+ "desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns this panel's title",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
+ "desc" : ""
}
- ],
+ ]
+ },
+ {
+ "name" : "getToolbar",
+ "type" : "function",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.Toolbar",
+ "desc" : ""
}
]
},
{
- "name" : "hide",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
- "name" : "isActive",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns true if this tab is the active tab.",
- "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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "isHidden",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Returns true if this tab is \"hidden\"",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
+ "sig" : "(url, params, callback, discardUrl)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "on",
"type" : "function",
{
"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.",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "setContent",
"type" : "function",
- "desc" : "Sets the content for this TabPanelItem.",
+ "desc" : "Updates this panel's element (not for iframe)",
"sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "content",
"type" : "String",
- "desc" : "The content",
+ "desc" : "The new content",
"isOptional" : false
},
{
"name" : "loadScripts",
"type" : "Boolean",
- "desc" : "true to look for and load scripts",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setHidden",
- "type" : "function",
- "desc" : "Show or hide the tab",
- "sig" : "(hidden)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to hide or false to show.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setText",
- "type" : "function",
- "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
- "sig" : "(text)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The tab's text and tooltip",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTooltip",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Set the tooltip for the tab.",
- "sig" : "(tooltip)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tooltip",
+ "name" : "title",
"type" : "String",
- "desc" : "The tab's tooltip",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "setUrl",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
"sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "url",
"type" : "String/Function",
- "desc" : "The URL to load the content from, or a function to call to get the URL",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
"isOptional" : false
},
{
{
"name" : "loadOnce",
"type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Roo.UpdateManager|Boolean",
+ "desc" : "The UpdateManager or false if IFRAME"
}
]
},
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.panel.Tabs" : {
+ "Roo.bootstrap.panel.TabItem" : {
"props" : [
{
"name" : "listeners",
],
"events" : [
{
- "name" : "beforetabchange",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
- "sig" : "function (_self, e, tab)\n{\n\n}",
+ "desc" : "Fires when this tab becomes the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "tabPanel",
"type" : "Roo.TabPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the tab change",
+ "desc" : "The parent TabPanel",
"isOptional" : false
},
{
- "name" : "tab",
+ "name" : "this",
"type" : "Roo.TabPanelItem",
- "desc" : "The tab being changed to",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "tabchange",
+ "name" : "beforeclose",
"type" : "function",
- "desc" : "Fires when the active tab changes",
- "sig" : "function (_self, activePanel)\n{\n\n}",
+ "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.TabPanel",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
},
{
- "name" : "activePanel",
- "type" : "Roo.TabPanelItem",
- "desc" : "The new active tab",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "activate",
- "type" : "function",
- "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to activate.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem."
- }
- ]
- },
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
+ "name" : "e",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "Set cancel to true on this object to cancel the close.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "close",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this tab is closed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "this",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addTab",
+ "name" : "deactivate",
"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 when this tab is no longer the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the div to use <b>or create</b>",
- "isOptional" : false
- },
- {
- "name" : "text",
- "type" : "String",
- "desc" : "The text for the tab",
- "isOptional" : false
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "(optional) Content to put in the TabPanelItem body",
+ "name" : "tabPanel",
+ "type" : "Roo.TabPanel",
+ "desc" : "The parent TabPanel",
"isOptional" : false
},
{
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "(optional) True to create a close icon on the tab",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The created TabPanelItem"
- }
- ]
- },
- {
- "name" : "addTabItem",
- "type" : "function",
- "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
- "sig" : "(item)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "item",
+ "name" : "this",
"type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem to add",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "autoSizeTabs",
+ "name" : "activate",
"type" : "function",
- "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
+ "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "beginUpdate",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "object",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Destroys this TabPanel",
- "sig" : "(removeEl)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disableTab",
+ "name" : "capture",
"type" : "function",
- "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to disable.",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enableTab",
+ "name" : "disable",
"type" : "function",
- "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
- "sig" : "(id)",
+ "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to enable.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "endUpdate",
+ "name" : "enable",
"type" : "function",
- "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
+ "desc" : "Enables this TabPanelItem if it was previously disabled.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
]
},
{
- "name" : "getActiveTab",
+ "name" : "getText",
"type" : "function",
- "desc" : "Gets the active {@link Roo.TabPanelItem}.",
+ "desc" : "Returns the text for this tab",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The active TabPanelItem or null if none are active."
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getCount",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Returns the number of tabs in this TabPanel.",
+ "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" : "",
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
{
- "name" : "getTab",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to fetch.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "hasListener",
+ "name" : "hide",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isActive",
+ "type" : "function",
+ "desc" : "Returns true if this tab is the active tab.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : ""
}
]
},
{
- "name" : "hideTab",
+ "name" : "isHidden",
"type" : "function",
- "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "desc" : "Returns true if this tab is \"hidden\"",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to hide.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "removeTab",
+ "name" : "setContent",
"type" : "function",
- "desc" : "Removes a {@link Roo.TabPanelItem}.",
- "sig" : "(id)",
+ "desc" : "Sets the content for this TabPanelItem.",
+ "sig" : "(content, loadScripts)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to remove.",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "The content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "true to look for and load scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTabWidth",
+ "name" : "setHidden",
"type" : "function",
- "desc" : "Resizes all the tabs to the passed width",
- "sig" : "(The)",
+ "desc" : "Show or hide the tab",
+ "sig" : "(hidden)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "The",
- "type" : "Number",
- "desc" : "new width",
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to hide or false to show.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "syncHeight",
+ "name" : "setText",
"type" : "function",
- "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
- "sig" : "(targetHeight)",
+ "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
+ "sig" : "(text)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "targetHeight",
- "type" : "Number",
- "desc" : "(optional) Override the starting height from the elements height",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The tab's text and tooltip",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "setTooltip",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Set the tooltip for the tab.",
+ "sig" : "(tooltip)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "tooltip",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The tab's tooltip",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unhideTab",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
- "sig" : "(id)",
+ "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to unhide.",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from, or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
+ "type" : "Boolean",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
"isOptional" : false
}
],
- "returns" : []
- }
- ]
- },
- "Roo.data" : {
- "props" : [],
- "events" : [],
- "methods" : []
- },
- "Roo.data.ArrayReader" : {
- "props" : [
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "Array of field definition objects",
- "memberOf" : ""
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
- "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" : "show",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.DataReader",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Object",
- "desc" : "An Array of row objects which represents the dataset.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records."
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.data.Connection" : {
+ "Roo.bootstrap.panel.Tabs" : {
"props" : [
- {
- "name" : "autoAbort",
- "type" : "Boolean",
- "desc" : "(Optional) Whether this request should abort any pending requests. (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" : "disableCaching",
- "type" : "Boolean",
- "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (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)",
- "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" : "(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" : "timeout",
- "type" : "Number",
- "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : ""
- },
- {
- "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" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (conn, options)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "requestcomplete",
+ "name" : "beforetabchange",
"type" : "function",
- "desc" : "Fires if the request was successfully completed.",
- "sig" : "function (conn, response, options)\n{\n\n}",
+ "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
+ "sig" : "function (_self, e, tab)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
+ "name" : "this",
+ "type" : "Roo.TabPanel",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "response",
+ "name" : "e",
"type" : "Object",
- "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "desc" : "Set cancel to true on this object to cancel the tab change",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
+ "name" : "tab",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The tab being changed to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "requestexception",
+ "name" : "tabchange",
"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}",
+ "desc" : "Fires when the active tab changes",
+ "sig" : "function (_self, activePanel)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
- "isOptional" : false
- },
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "name" : "this",
+ "type" : "Roo.TabPanel",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
+ "name" : "activePanel",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The new active tab",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "abort",
+ "name" : "activate",
"type" : "function",
- "desc" : "Aborts any outstanding request.",
- "sig" : "(transactionId)",
+ "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "transactionId",
- "type" : "Number",
- "desc" : "(Optional) defaults to the last transaction",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to activate.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The TabPanelItem."
+ }
+ ]
},
{
"name" : "addEvents",
"returns" : []
},
{
- "name" : "capture",
+ "name" : "addTab",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
+ "sig" : "(id, text, content, closable)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the div to use <b>or create</b>",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text for the tab",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "content",
+ "type" : "String",
+ "desc" : "(optional) Content to put in the TabPanelItem body",
+ "isOptional" : false
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "(optional) True to create a close icon on the tab",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The created TabPanelItem"
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "addTabItem",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
+ "sig" : "(item)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "item",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The TabPanelItem to add",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "autoSizeTabs",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "isLoading",
+ "name" : "beginUpdate",
"type" : "function",
- "desc" : "Determine whether this object has a request outstanding.",
- "sig" : "(transactionId)",
+ "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "transactionId",
- "type" : "Number",
- "desc" : "(Optional) defaults to the last transaction",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if there is an outstanding request."
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "capture",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this TabPanel",
+ "sig" : "(removeEl)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "disableTab",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "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.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to disable.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "enableTab",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to enable.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "request",
+ "name" : "getActiveTab",
"type" : "function",
- "desc" : "Sends an HTTP request to a remote server.",
- "sig" : "(options)",
+ "desc" : "Gets the active {@link Roo.TabPanelItem}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} (Optional) The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} (Optional) An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} (Optional) The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} (Optional) The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} (Optional) The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} (Optional) The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} (Optional) The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} (Optional) A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} (Optional) True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} (Optional) Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} (Optional) XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} (Optional) True to add a unique cache-buster param to GET requests.</li>\n</ul>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The active TabPanelItem or null if none are active."
}
- ],
+ ]
+ },
+ {
+ "name" : "getCount",
+ "type" : "function",
+ "desc" : "Returns the number of tabs in this TabPanel.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
"type" : "Number",
- "desc" : "transactionId"
+ "desc" : ""
}
]
},
{
- "name" : "un",
+ "name" : "getTab",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to fetch.",
"isOptional" : false
}
],
- "returns" : []
- }
- ]
- },
- "Roo.data.DataProxy" : {
- "props" : [],
- "events" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : ""
+ }
+ ]
+ },
{
- "name" : "beforeload",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (This, params)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "Object",
- "desc" : "The params parameter to the load function.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "load",
+ "name" : "hideTab",
"type" : "function",
- "desc" : "Fires before the load method's callback is called.",
- "sig" : "function (This, o, arg)\n{\n\n}",
+ "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
- "isOptional" : false
- },
- {
- "name" : "arg",
- "type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to hide.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires if an Exception occurs during data retrieval.",
- "sig" : "function (This, o, arg, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "arg",
+ "name" : "scope",
"type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
+ "name" : "options",
"type" : "Object",
- "desc" : "The Exception.",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : []
- },
- "Roo.data.DataReader" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "newRow",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
- }
- ]
- }
- ]
- },
- "Roo.data.HttpProxy" : {
- "props" : [
- {
- "name" : "autoAbort",
- "type" : "Boolean",
- "desc" : "(Optional) Whether this request should abort any pending requests. (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" : "disableCaching",
- "type" : "Boolean",
- "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (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)",
- "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)",
- "memberOf" : ""
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : ""
+ "params" : [],
+ "returns" : []
},
{
- "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" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (This, params)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy",
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "Object",
- "desc" : "The params parameter to the load function.",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires before the load method's callback is called.",
- "sig" : "function (This, o, arg)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "arg",
+ "name" : "scope",
"type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "removeTab",
"type" : "function",
- "desc" : "Fires if an Exception occurs during data retrieval.",
- "sig" : "function (This, o, arg, e)\n{\n\n}",
- "memberOf" : "Roo.data.DataProxy",
+ "desc" : "Removes a {@link Roo.TabPanelItem}.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
- "isOptional" : false
- },
- {
- "name" : "arg",
- "type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The Exception.",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to remove.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "getConnection",
+ "name" : "setTabWidth",
"type" : "function",
- "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Resizes all the tabs to the passed width",
+ "sig" : "(The)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Connection",
- "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "new width",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "load",
+ "name" : "syncHeight",
"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" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
+ "sig" : "(targetHeight)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "params",
- "type" : "Object",
- "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
+ "name" : "targetHeight",
+ "type" : "Number",
+ "desc" : "(optional) Override the starting height from the elements height",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "callback",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "The scope in which to call the callback",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "unhideTab",
+ "type" : "function",
+ "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "arg",
- "type" : "Object",
- "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to unhide.",
"isOptional" : false
}
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.data.JsonReader" : {
+ "Roo.data" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.ArrayReader" : {
"props" : [
{
"name" : "fields",
"type" : "Array",
"desc" : "Array of field definition objects",
- "memberOf" : ""
+ "memberOf" : "Roo.data.ArrayReader"
},
{
"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" : ""
- },
- {
- "name" : "totalProperty",
- "type" : "String",
- "desc" : "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
- "memberOf" : ""
+ "desc" : "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" : "Roo.data.ArrayReader"
}
],
"events" : [],
}
]
},
- {
- "name" : "read",
- "type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object which contains the JSON data in its responseText.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
- }
- ]
- },
{
"name" : "readRecords",
"type" : "function",
{
"name" : "o",
"type" : "Object",
- "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.",
+ "desc" : "An Array of row objects which represents the dataset.",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Object",
- "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
+ "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records."
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.data.JsonStore" : {
+ "Roo.data.Connection" : {
"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" : "autoAbort",
+ "type" : "Boolean",
+ "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf" : "Roo.data.Connection"
},
{
- "name" : "data",
- "type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : "Roo.data.Store"
+ "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" : "Roo.data.Connection"
},
{
- "name" : "fields",
- "type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : ""
+ "name" : "disableCaching",
+ "type" : "Boolean",
+ "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf" : "Roo.data.Connection"
},
{
- "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" : "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" : "Roo.data.Connection"
},
{
"name" : "listeners",
"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" : "[required] 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.DataReader",
- "desc" : "[required] 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" : "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" : "Roo.data.Connection"
},
{
- "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" : "timeout",
+ "type" : "Number",
+ "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : "Roo.data.Connection"
},
{
- "name" : "sortInfo",
- "type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store"
+ "name" : "url",
+ "type" : "String",
+ "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf" : "Roo.data.Connection"
}
],
"events" : [
{
- "name" : "add",
+ "name" : "beforerequest",
"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 a network request is made to retrieve a data object.",
+ "sig" : "function (conn, options)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The array of Records added",
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
"isOptional" : false
},
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index at which the record(s) were added",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options config object passed to the {@link #request} method.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeload",
+ "name" : "requestcomplete",
"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 if the request was successfully completed.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "desc" : "The options config object passed to the {@link #request} method.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadadd",
+ "name" : "requestexception",
"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 if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "desc" : "The options config object passed to the {@link #request} method.",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "clear",
+ "name" : "abort",
"type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Aborts any outstanding request.",
+ "sig" : "(transactionId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "transactionId",
+ "type" : "Number",
+ "desc" : "(Optional) defaults to the last transaction",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "datachanged",
+ "name" : "addEvents",
"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" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "addListener",
"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" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "capture",
"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" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "",
- "type" : "Proxy",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "return",
- "type" : "Object",
- "desc" : "from JsonData.reader() - success, totalRecords, records",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "load",
- "type" : "Object",
- "desc" : "options",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "jsonData",
+ "name" : "scope",
"type" : "Object",
- "desc" : "from your request (normally this contains the Exception)",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "metachange",
+ "name" : "fireEvent",
"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 the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
},
{
- "name" : "meta",
- "type" : "Object",
- "desc" : "The JSON metadata",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "remove",
+ "name" : "hasListener",
"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" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was removed",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "isLoading",
+ "type" : "function",
+ "desc" : "Determine whether this object has a request outstanding.",
+ "sig" : "(transactionId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "index",
+ "name" : "transactionId",
"type" : "Number",
- "desc" : "The index at which the record was removed",
+ "desc" : "(Optional) defaults to the last transaction",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if there is an outstanding request."
+ }
+ ]
},
{
- "name" : "update",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was updated",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "operation",
- "type" : "String",
- "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "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",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "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",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "request",
+ "type" : "function",
+ "desc" : "Sends an HTTP request to a remote server.",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} (Optional) The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} (Optional) An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} (Optional) The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} (Optional) The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} (Optional) The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} (Optional) The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} (Optional) The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} (Optional) A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} (Optional) True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} (Optional) Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} (Optional) XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} (Optional) True to add a unique cache-buster param to GET requests.</li>\n</ul>",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "transactionId"
+ }
+ ]
},
{
- "name" : "capture",
+ "name" : "un",
"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 a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.data.Connection" : [
+ "Roo.Ajax"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.DataProxy" : {
+ "props" : [
{
- "name" : "clearFilter",
+ "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" : "beforeload",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "If true the filter is cleared silently without notifying listeners",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "The params parameter to the load function.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collect",
+ "name" : "load",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The property to collect",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
"isOptional" : false
},
{
- "name" : "allowNull",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
"isOptional" : false
},
{
- "name" : "bypassFilter",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "An array of the unique values"
- }
- ]
+ "returns" : []
},
{
- "name" : "commitChanges",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "each",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "object",
"type" : "Object",
- "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filter",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
+ "name" : "eventName",
"type" : "String",
- "desc" : "A field on your records",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filterBy",
+ "name" : "capture",
"type" : "function",
- "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
]
},
{
- "name" : "getAt",
- "type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the Record to find.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record at the passed index. Returns undefined if not found."
- }
- ]
- },
- {
- "name" : "getById",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The id of the Record to find.",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record with the passed id. Returns undefined if not found."
- }
- ]
- },
- {
- "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",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "getModifiedRecords",
- "type" : "function",
- "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records containing outstanding modifications."
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getRange",
+ "name" : "on",
"type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "(optional) The starting index (defaults to 0)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getSortState",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "getTotalCount",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "indexOf",
+ "name" : "un",
"type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Roo.data.Record object to to find.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the passed Record. Returns -1 if not found."
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.data.DataProxy" : [
+ "Roo.data.HttpProxy"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.DataReader" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "indexOfId",
+ "name" : "newRow",
"type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The index of the Record. Returns -1 if not found."
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
}
]
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.data.DataReader" : [
+ "Roo.data.ArrayReader",
+ "Roo.data.JsonReader",
+ "Roo.data.XmlReader"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.HttpProxy" : {
+ "props" : [
+ {
+ "name" : "autoAbort",
+ "type" : "Boolean",
+ "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf" : "Roo.data.HttpProxy"
},
{
- "name" : "insert",
+ "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" : "Roo.data.HttpProxy"
+ },
+ {
+ "name" : "disableCaching",
+ "type" : "Boolean",
+ "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf" : "Roo.data.HttpProxy"
+ },
+ {
+ "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" : "Roo.data.HttpProxy"
+ },
+ {
+ "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" : "(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" : "Roo.data.HttpProxy"
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : "Roo.data.HttpProxy"
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf" : "Roo.data.HttpProxy"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeload",
"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",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The start index at which to insert the passed Records.",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "The params parameter to the load function.",
"isOptional" : false
}
],
{
"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",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "options",
+ "name" : "This",
"type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadData",
+ "name" : "loadexception",
"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",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "data",
+ "name" : "This",
"type" : "Object",
- "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "desc" : "DataProxy object.",
"isOptional" : false
},
{
- "name" : "append",
- "type" : "Boolean",
- "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "loadDataFromChildren",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
- "sig" : "(rec)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rec",
+ "name" : "object",
"type" : "Object",
- "desc" : "The record with a 'children array",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "capture",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "query",
- "type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
- }
- ]
+ "returns" : []
},
{
- "name" : "queryBy",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
- "sig" : "(fn, scope)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "rejectChanges",
+ "name" : "getConnection",
"type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
+ "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Connection",
+ "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "reload",
+ "name" : "load",
"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" : "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.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
+ "name" : "params",
"type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
+ "isOptional" : false
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope in which to call the callback",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "An optional argument which is passed to the callback as its second parameter.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "on",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDefaultSort",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The name of the field to sort by.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sort",
+ "name" : "un",
"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" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The name of the field to sort by.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.JsonReader" : {
+ "props" : [
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "Array of field definition objects",
+ "memberOf" : "Roo.data.JsonReader"
},
{
- "name" : "sum",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "Name of the property within a row object that contains a record identifier value.",
+ "memberOf" : "Roo.data.JsonReader"
+ },
+ {
+ "name" : "root",
+ "type" : "String",
+ "desc" : "name of the property which contains the Array of row objects.",
+ "memberOf" : "Roo.data.JsonReader"
+ },
+ {
+ "name" : "successProperty",
+ "type" : "String",
+ "desc" : "Name of the property from which to retrieve the success attribute used by forms.",
+ "memberOf" : "Roo.data.JsonReader"
+ },
+ {
+ "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" : "Roo.data.JsonReader"
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
"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" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.data.DataReader",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The sum"
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
}
]
},
{
- "name" : "un",
+ "name" : "read",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
+ "sig" : "(response)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "response",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The XHR object which contains the JSON data in its responseText.",
"isOptional" : false
}
],
- "returns" : []
- }
- ]
- },
- "Roo.data.MemoryProxy" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
+ }
+ ]
+ },
{
- "name" : "load",
+ "name" : "readRecords",
"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)",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(o)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "params",
- "type" : "Object",
- "desc" : "This parameter is not used by the MemoryProxy class.",
- "isOptional" : false
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "o",
"type" : "Object",
- "desc" : "The scope in which to call the callback",
+ "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "arg",
+ "name" : "",
"type" : "Object",
- "desc" : "An optional argument which is passed to the callback as its second parameter.",
- "isOptional" : false
+ "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
}
- ],
- "returns" : []
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.data.Node" : {
+ "Roo.data.JsonStore" : {
"props" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id for this node. If one is not specified, one is generated.",
- "memberOf" : ""
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf" : "Roo.data.Store"
},
{
- "name" : "leaf",
- "type" : "Boolean",
- "desc" : "true if this node is a leaf and does not have children",
- "memberOf" : ""
+ "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" : "Roo.data.JsonStore"
+ },
+ {
+ "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" : "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" : "[required] 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.DataReader",
+ "desc" : "[required] 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" : "append",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when a new child node is appended",
- "sig" : "function (tree, _self, node, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The newly appended node",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The array of Records added",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index of the newly appended node",
+ "desc" : "The index at which the record(s) were added",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeappend",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires before a new child is appended, return false to cancel the append.",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be appended",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeinsert",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be inserted",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node is being inserted before",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforemove",
+ "name" : "clear",
"type" : "function",
- "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
- "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The parent of this node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent this node is moving to",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "datachanged",
+ "type" : "function",
+ "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it is being moved to",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires before a child is removed, return false to cancel the remove.",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be removed",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires when a new child node is inserted.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
+ "sig" : "function (, return, load, jsonData)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "",
+ "type" : "Proxy",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "return",
+ "type" : "Object",
+ "desc" : "from JsonData.reader() - success, totalRecords, records",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node inserted",
+ "name" : "load",
+ "type" : "Object",
+ "desc" : "options",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node was inserted before",
+ "name" : "jsonData",
+ "type" : "Object",
+ "desc" : "from your request (normally this contains the Exception)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "metachange",
"type" : "function",
- "desc" : "Fires when this node is moved to a new location in the tree",
- "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
+ "sig" : "function (_self, meta)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "The JSON metadata",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The old parent of this node",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent of this node",
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was removed",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index it was moved to",
+ "desc" : "The index at which the record was removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "update",
"type" : "function",
- "desc" : "Fires when a child node is removed",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was updated",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The removed node",
+ "name" : "operation",
+ "type" : "String",
+ "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
"isOptional" : false
}
],
}
],
"methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "appendChild",
+ "name" : "capture",
"type" : "function",
- "desc" : "Insert node(s) as the last child node of this node.",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node/Array",
- "desc" : "The node or Array of nodes to append",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Node",
- "desc" : "The appended node if single append, or null if an array was passed"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "bubble",
+ "name" : "clearFilter",
"type" : "function",
- "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "If true the filter is cleared silently without notifying listeners",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "collect",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The property to collect",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "allowNull",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to allow null, undefined or empty string values",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "bypassFilter",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of the unique values"
+ }
+ ]
+ },
+ {
+ "name" : "commitChanges",
+ "type" : "function",
+ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "cascade",
+ "name" : "each",
"type" : "function",
- "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "contains",
+ "name" : "filter",
"type" : "function",
- "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
- "sig" : "(node)",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "eachChild",
+ "name" : "filterBy",
"type" : "function",
- "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "findChild",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Finds the first child that has the attribute with the specified value.",
- "sig" : "(attribute, value)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "attribute",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The attribute name",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to search for",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "findChildBy",
+ "name" : "getAt",
"type" : "function",
- "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
- "sig" : "(fn, scope)",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record at the passed index. Returns undefined if not found."
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getById",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "id",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record with the passed id. Returns undefined if not found."
}
]
},
{
- "name" : "getDepth",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Returns depth of this node (the root node has a depth of 0)",
+ "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getOwnerTree",
+ "name" : "getModifiedRecords",
"type" : "function",
- "desc" : "Returns the tree this node is in.",
+ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Tree",
- "desc" : ""
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records containing outstanding modifications."
}
]
},
{
- "name" : "getPath",
+ "name" : "getRange",
"type" : "function",
- "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
- "sig" : "(attr)",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "attr",
- "type" : "String",
- "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) The starting index (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The path"
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records"
}
]
},
+ {
+ "name" : "getSortState",
+ "type" : "function",
+ "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getTotalCount",
+ "type" : "function",
+ "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "indexOf",
"type" : "function",
- "desc" : "Returns the index of a child node",
- "sig" : "(node)",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Roo.data.Record object to to find.",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Number",
- "desc" : "The index of the node or -1 if it was not found"
+ "desc" : "The index of the passed Record. Returns -1 if not found."
}
]
},
{
- "name" : "insertBefore",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
- "sig" : "(node, refNode)",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to insert",
- "isOptional" : false
- },
- {
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The node to insert before (if null the node is appended)",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The inserted node"
+ "type" : "Number",
+ "desc" : "The index of the Record. Returns -1 if not found."
}
]
},
{
- "name" : "isAncestor",
+ "name" : "insert",
"type" : "function",
- "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
- "sig" : "(node)",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The start index at which to insert the passed Records.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isFirst",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this node is the first child of its parent",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isLast",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Returns true if this node is the last child of its parent",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
+ "sig" : "(data, append)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isLeaf",
- "type" : "function",
- "desc" : "Returns true if this node is a leaf",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "isOptional" : false
+ },
{
- "name" : "",
+ "name" : "append",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "item",
+ "name" : "loadDataFromChildren",
"type" : "function",
- "desc" : "Returns the child node at the specified index.",
- "sig" : "(index)",
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "",
+ "name" : "rec",
+ "type" : "Object",
+ "desc" : "The record with a 'children array",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "query",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
},
{
- "name" : "removeChild",
+ "name" : "queryBy",
"type" : "function",
- "desc" : "Removes a child node from this node.",
- "sig" : "(node)",
+ "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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to remove",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The removed node"
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
}
]
},
{
- "name" : "removeListener",
+ "name" : "rejectChanges",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Cancel outstanding changes on all changed records.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "replaceChild",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Replaces one child node in this node with another.",
- "sig" : "(newChild, oldChild)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "newChild",
- "type" : "Node",
- "desc" : "The replacement node",
- "isOptional" : false
- },
- {
- "name" : "oldChild",
- "type" : "Node",
- "desc" : "The node to replace",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The replaced node"
- }
- ]
+ "returns" : []
},
{
- "name" : "sort",
+ "name" : "reload",
"type" : "function",
- "desc" : "Sorts this nodes children using the supplied sort function",
- "sig" : "(fn, scope)",
+ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
"isOptional" : false
}
],
"returns" : []
- }
- ]
- },
- "Roo.data.Record" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "commit",
+ "name" : "removeAll",
"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" : "Remove all Records from the Store and fires the clear event.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "copy",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Creates a copy of this record.",
- "sig" : "(id)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "eventName",
"type" : "String",
- "desc" : "(optional) A new record id if you don't want to use this record's id",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Record",
- "desc" : ""
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "create",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Generate a constructor for a specific record layout.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
+ "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",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Array",
- "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <ul>\n<li><b>name</b> : String<p style=\"margin-left:1em\">The name by which the field is referenced within the Record. This is referenced by,\nfor example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>\n<li><b>mapping</b> : String<p style=\"margin-left:1em\">(Optional) A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.</p></li>\n<li><b>type</b> : String<p style=\"margin-left:1em\">(Optional) The data type for conversion to displayable value. Possible values are\n<ul><li>auto (Default, implies no conversion)</li>\n<li>string</li>\n<li>int</li>\n<li>float</li>\n<li>boolean</li>\n<li>date</li></ul></p></li>\n<li><b>sortType</b> : Mixed<p style=\"margin-left:1em\">(Optional) A member of {@link Roo.data.SortTypes}.</p></li>\n<li><b>sortDir</b> : String<p style=\"margin-left:1em\">(Optional) Initial direction to sort. \"ASC\" or \"DESC\"</p></li>\n<li><b>convert</b> : Function<p style=\"margin-left:1em\">(Optional) A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:<ul>\n<li><b>v</b> : Mixed<p style=\"margin-left:1em\">The data value as read by the Reader.</p></li>\n</ul></p></li>\n<li><b>dateFormat</b> : String<p style=\"margin-left:1em\">(Optional) A format String for the Date.parseDate function.</p></li>\n</ul>\n<br>usage:<br><pre><code>\nvar TopicRecord = Roo.data.Record.create(\n {name: 'title', mapping: 'topic_title'},\n {name: 'author', mapping: 'username'},\n {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n {name: 'lastPost', mapping: 'post_time', type: 'date'},\n {name: 'lastPoster', mapping: 'user2'},\n {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n title: 'Do my job please',\n author: 'noobie',\n totalPosts: 1,\n lastPost: new Date(),\n lastPoster: 'Animal',\n excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n</code></pre>",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
+ "isOptional" : false
+ },
+ {
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "get",
+ "name" : "sort",
"type" : "function",
- "desc" : "Get the value of the named field.",
- "sig" : "(name)",
+ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
+ "name" : "fieldName",
"type" : "String",
- "desc" : "The name of the field to get the value of.",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Object",
- "desc" : "The value of the field."
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "reject",
+ "name" : "sum",
"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" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
+ "sig" : "(property, start, end)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The sum"
+ }
+ ]
},
{
- "name" : "set",
+ "name" : "un",
"type" : "function",
- "desc" : "Set the named field to the specified value.",
- "sig" : "(name, value)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The name of the field to set.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "value",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "The value to set the field to.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
}
- ]
- },
- "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" : "nocache",
- "type" : "Boolean",
- "desc" : "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
- "memberOf" : ""
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
- "memberOf" : ""
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "The URL from which to request the data object.",
- "memberOf" : ""
- }
],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.MemoryProxy" : {
+ "props" : [],
"events" : [],
"methods" : [
- {
- "name" : "abort",
- "type" : "function",
- "desc" : "Abort the current server request.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "load",
"type" : "function",
- "desc" : "Load data from the 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.",
+ "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
"sig" : "(params, reader, callback, scope, arg)",
"static" : false,
"memberOf" : "",
{
"name" : "params",
"type" : "Object",
- "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
+ "desc" : "This parameter is not used by the MemoryProxy class.",
"isOptional" : false
},
{
{
"name" : "callback",
"type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.
Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "desc" : "The function into which to pass the block of Roo.data.
records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
"isOptional" : false
},
{
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.data.SimpleStore" : {
+ "Roo.data.Node" : {
"props" : [
- {
- "name" : "an",
- "type" : "Object",
- "desc" : "existing reader (eg. copied from another store)",
- "memberOf" : ""
- },
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "data",
- "type" : "Array",
- "desc" : "The multi-dimensional array of data",
- "memberOf" : ""
- },
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : ""
- },
{
"name" : "id",
- "type" : "Number",
- "desc" : "The array index of the record id. Leave blank to auto generate ids.",
- "memberOf" : ""
+ "type" : "String",
+ "desc" : "The id for this node. If one is not specified, one is generated.",
+ "memberOf" : "Roo.data.Node"
},
{
- "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" : "leaf",
+ "type" : "Boolean",
+ "desc" : "true if this node is a leaf and does not have children",
+ "memberOf" : "Roo.data.Node"
},
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
"memberOf" : "Roo.util.Observable"
- },
- {
- "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" : "[not-required]",
- "memberOf" : ""
- },
- {
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "reader",
- "type" : "Roo.data.Reader",
- "desc" : "[not-required]",
- "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" : "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",
+ "name" : "append",
"type" : "function",
- "desc" : "Fires when Records have been added to the Store",
- "sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when a new child node is appended",
+ "sig" : "function (tree, _self, node, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The array of Records added",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The newly appended node",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index at which the record(s) were added",
+ "desc" : "The index of the newly appended node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeload",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
- "sig" : "function (_self, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before a new child is appended, return false to cancel the append.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be appended",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadadd",
+ "name" : "beforeinsert",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be inserted",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node is being inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clear",
+ "name" : "beforemove",
"type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
+ "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "datachanged",
- "type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent this node is moving to",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it is being moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "beforeremove",
"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" : "Fires before a child is removed, return false to cancel the remove.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "insert",
"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 when a new child node is inserted.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "",
- "type" : "Proxy",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "return",
- "type" : "Object",
- "desc" : "from JsonData.reader() - success, totalRecords, records",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "load",
- "type" : "Object",
- "desc" : "options",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node inserted",
"isOptional" : false
},
{
- "name" : "jsonData",
- "type" : "Object",
- "desc" : "from your request (normally this contains the Exception)",
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "metachange",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
- "sig" : "function (_self, meta)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when this node is moved to a new location in the tree",
+ "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "meta",
- "type" : "Object",
- "desc" : "The JSON metadata",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when a Record has been removed from the Store",
- "sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was removed",
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index at which the record was removed",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "update",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when a child node is removed",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was updated",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "operation",
- "type" : "String",
- "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The removed node",
"isOptional" : false
}
],
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "capture",
+ "name" : "appendChild",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Insert node(s) as the last child node of this node.",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "node",
+ "type" : "Node/Array",
+ "desc" : "The node or Array of nodes to append",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The appended node if single append, or null if an array was passed"
+ }
+ ]
},
{
- "name" : "clearFilter",
+ "name" : "bubble",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
+ "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "If true the filter is cleared silently without notifying listeners",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collect",
+ "name" : "capture",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The property to collect",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "allowNull",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "bypassFilter",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "An array of the unique values"
- }
- ]
- },
- {
- "name" : "commitChanges",
- "type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "each",
+ "name" : "cascade",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filter",
+ "name" : "contains",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "anyMatch",
+ "name" : "",
"type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "filterBy",
+ "name" : "eachChild",
"type" : "function",
- "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
+ "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "findChild",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Finds the first child that has the attribute with the specified value.",
+ "sig" : "(attribute, value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "attribute",
"type" : "String",
- "desc" : "",
+ "desc" : "The attribute name",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to search for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
}
]
},
{
- "name" : "getAt",
+ "name" : "findChildBy",
"type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
+ "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the Record to find.",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record at the passed index. Returns undefined if not found."
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
}
]
},
{
- "name" : "getById",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The id of the Record to find.",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record with the passed id. Returns undefined if not found."
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getCount",
+ "name" : "getDepth",
"type" : "function",
- "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "desc" : "Returns depth of this node (the root node has a depth of 0)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "getModifiedRecords",
+ "name" : "getOwnerTree",
"type" : "function",
- "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "desc" : "Returns the tree this node is in.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records containing outstanding modifications."
+ "type" : "Tree",
+ "desc" : ""
}
]
},
{
- "name" : "getRange",
+ "name" : "getPath",
"type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
+ "sig" : "(attr)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "(optional) The starting index (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "name" : "attr",
+ "type" : "String",
+ "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records"
+ "type" : "String",
+ "desc" : "The path"
}
]
},
- {
- "name" : "getSortState",
- "type" : "function",
- "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "getTotalCount",
- "type" : "function",
- "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "indexOf",
"type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
+ "desc" : "Returns the index of a child node",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Roo.data.Record object to to find.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Number",
- "desc" : "The index of the passed Record. Returns -1 if not found."
+ "desc" : "The index of the node or -1 if it was not found"
}
]
},
{
- "name" : "indexOfId",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
+ "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
+ "sig" : "(node, refNode)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to insert",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The node to insert before (if null the node is appended)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The index of the Record. Returns -1 if not found."
+ "type" : "Node",
+ "desc" : "The inserted node"
}
]
},
{
- "name" : "insert",
+ "name" : "isAncestor",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The start index at which to insert the passed Records.",
- "isOptional" : false
- },
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "load",
+ "name" : "isFirst",
"type" : "function",
- "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
- "sig" : "(options)",
+ "desc" : "Returns true if this node is the first child of its parent",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "loadData",
+ "name" : "isLast",
"type" : "function",
- "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
- "sig" : "(data, append)",
+ "desc" : "Returns true if this node is the last child of its parent",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "isLeaf",
+ "type" : "function",
+ "desc" : "Returns true if this node is a leaf",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "append",
+ "name" : "",
"type" : "Boolean",
- "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "loadDataFromChildren",
+ "name" : "item",
"type" : "function",
- "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
- "sig" : "(rec)",
+ "desc" : "Returns the child node at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rec",
- "type" : "Object",
- "desc" : "The record with a 'children array",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
- {
- "name" : "query",
- "type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
- "isOptional" : false
- },
- {
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
- }
- ]
- },
- {
- "name" : "queryBy",
- "type" : "function",
- "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
- "sig" : "(fn, scope)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
- }
- ]
- },
- {
- "name" : "rejectChanges",
- "type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "reload",
+ "name" : "removeChild",
"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 child node from this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to remove",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The removed node"
}
- ],
- "returns" : []
- },
- {
- "name" : "removeAll",
- "type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ ]
},
{
"name" : "removeListener",
"returns" : []
},
{
- "name" : "setDefaultSort",
+ "name" : "replaceChild",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Replaces one child node in this node with another.",
+ "sig" : "(newChild, oldChild)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
+ "name" : "newChild",
+ "type" : "Node",
+ "desc" : "The replacement node",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "name" : "oldChild",
+ "type" : "Node",
+ "desc" : "The node to replace",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "sort",
- "type" : "function",
- "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
- "sig" : "(fieldName, dir)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
- "isOptional" : false
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The replaced node"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "sum",
+ "name" : "sort",
"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" : "Sorts this nodes children using the supplied sort function",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The sum"
- }
- ]
+ "returns" : []
},
{
"name" : "un",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.data.Node" : [
+ "Roo.tree.TreeNode"
+ ],
+ "Roo.tree.TreeNode" : [
+ "Roo.tree.AsyncTreeNode"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.data.SortTypes" : {
+ "Roo.data.Record" : {
"props" : [],
"events" : [],
"methods" : [
{
- "name" : "asDate",
+ "name" : "commit",
"type" : "function",
- "desc" : "Date sorting",
- "sig" : "(s)",
- "static" : true,
+ "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The comparison value"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "asFloat",
+ "name" : "copy",
"type" : "function",
- "desc" : "Float sorting",
- "sig" : "(s)",
- "static" : true,
+ "desc" : "Creates a copy of this record.",
+ "sig" : "(id)",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "(optional) A new record id if you don't want to use this record's id",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Float",
- "desc" : "The comparison value"
+ "type" : "Record",
+ "desc" : ""
}
]
},
{
- "name" : "asInt",
+ "name" : "create",
"type" : "function",
- "desc" : "Integer sorting",
- "sig" : "(s)",
+ "desc" : "Generate a constructor for a specific record layout.",
+ "sig" : "(o)",
"static" : true,
"memberOf" : "",
"isStatic" : true,
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "o",
+ "type" : "Array",
+ "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <ul>\n<li><b>name</b> : String<p style=\"margin-left:1em\">The name by which the field is referenced within the Record. This is referenced by,\nfor example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>\n<li><b>mapping</b> : String<p style=\"margin-left:1em\">(Optional) A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.</p></li>\n<li><b>type</b> : String<p style=\"margin-left:1em\">(Optional) The data type for conversion to displayable value. Possible values are\n<ul><li>auto (Default, implies no conversion)</li>\n<li>string</li>\n<li>int</li>\n<li>float</li>\n<li>boolean</li>\n<li>date</li></ul></p></li>\n<li><b>sortType</b> : Mixed<p style=\"margin-left:1em\">(Optional) A member of {@link Roo.data.SortTypes}.</p></li>\n<li><b>sortDir</b> : String<p style=\"margin-left:1em\">(Optional) Initial direction to sort. \"ASC\" or \"DESC\"</p></li>\n<li><b>convert</b> : Function<p style=\"margin-left:1em\">(Optional) A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:<ul>\n<li><b>v</b> : Mixed<p style=\"margin-left:1em\">The data value as read by the Reader.</p></li>\n</ul></p></li>\n<li><b>dateFormat</b> : String<p style=\"margin-left:1em\">(Optional) A format String for the Date.parseDate function.</p></li>\n</ul>\n<br>usage:<br><pre><code>\nvar TopicRecord = Roo.data.Record.create(\n {name: 'title', mapping: 'topic_title'},\n {name: 'author', mapping: 'username'},\n {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n {name: 'lastPost', mapping: 'post_time', type: 'date'},\n {name: 'lastPoster', mapping: 'user2'},\n {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n title: 'Do my job please',\n author: 'noobie',\n totalPosts: 1,\n lastPost: new Date(),\n lastPoster: 'Animal',\n excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n</code></pre>",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The comparison value"
- }
- ]
+ "returns" : []
},
{
- "name" : "asText",
+ "name" : "get",
"type" : "function",
- "desc" : "Strips all HTML tags to sort on text only",
- "sig" : "(s)",
- "static" : true,
+ "desc" : "Get the value of the named field.",
+ "sig" : "(name)",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The name of the field to get the value of.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The comparison value"
+ "type" : "Object",
+ "desc" : "The value of the field."
}
]
},
{
- "name" : "asUCString",
+ "name" : "reject",
"type" : "function",
- "desc" : "Case insensitive string",
- "sig" : "(s)",
- "static" : true,
+ "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" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "asUCText",
+ "name" : "set",
"type" : "function",
- "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
- "sig" : "(s)",
- "static" : true,
+ "desc" : "Set the named field to the specified value.",
+ "sig" : "(name, value)",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The name of the field to set.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "The value to set the field to.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "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" : "Roo.data.ScriptTagProxy"
},
{
- "name" : "none",
+ "name" : "nocache",
+ "type" : "Boolean",
+ "desc" : "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
+ "memberOf" : "Roo.data.ScriptTagProxy"
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "desc" : "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
+ "memberOf" : "Roo.data.ScriptTagProxy"
+ },
+ {
+ "name" : "url",
+ "type" : "String",
+ "desc" : "The URL from which to request the data object.",
+ "memberOf" : "Roo.data.ScriptTagProxy"
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "abort",
"type" : "function",
- "desc" : "Default sort that does nothing",
- "sig" : "(s)",
- "static" : true,
+ "desc" : "Abort the current server request.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "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" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "The comparison value"
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope in which to call the callback",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.data.Store" : {
+ "Roo.data.SimpleStore" : {
"props" : [
+ {
+ "name" : "an",
+ "type" : "Object",
+ "desc" : "existing reader (eg. copied from another store)",
+ "memberOf" : "Roo.data.SimpleStore"
+ },
{
"name" : "baseParams",
"type" : "Object",
"desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "data",
"type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : ""
+ "desc" : "The multi-dimensional array of data",
+ "memberOf" : "Roo.data.SimpleStore"
+ },
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "An array of field definition objects, or field name strings.",
+ "memberOf" : "Roo.data.SimpleStore"
+ },
+ {
+ "name" : "id",
+ "type" : "Number",
+ "desc" : "The array index of the record id. Leave blank to auto generate ids.",
+ "memberOf" : "Roo.data.SimpleStore"
},
{
"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" : ""
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "listeners",
"name" : "multiSort",
"type" : "Boolean",
"desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "proxy",
"type" : "Roo.data.DataProxy",
- "desc" : "[required] The Proxy object which provides access to a data object.",
- "memberOf" : ""
+ "desc" : "[not-required]",
+ "memberOf" : "Roo.data.SimpleStore"
},
{
"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" : ""
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "[required] 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" : ""
+ "type" : "Roo.data.Reader",
+ "desc" : "[not-required]",
+ "memberOf" : "Roo.data.SimpleStore"
},
{
"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" : ""
+ "memberOf" : "Roo.data.Store"
},
{
"name" : "sortInfo",
"type" : "Object",
"desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : ""
+ "memberOf" : "Roo.data.Store"
}
],
"events" : [
"type" : "function",
"desc" : "Fires when Records have been added to the Store",
"sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
"sig" : "function (_self, options)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after a new set of Records has been loaded.",
"sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when the data cache has been cleared.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
"sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"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" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"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" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when a Record has been removed from the Store",
"sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when a Record has been updated",
"sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Add Records to the Store and fires the add event.",
"sig" : "(records)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Revert to a view of the Record cache with no filtering applied.",
"sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Collects unique values for a particular dataIndex from this store.",
"sig" : "(dataIndex, allowNull, bypassFilter)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Calls the specified function for each of the Records in the cache.",
"sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Filter the records by a specified property.",
"sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
"sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the Record at the specified index.",
"sig" : "(index)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the Record with the specified id.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a range of Records between specified indices.",
"sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the index within the cache of the passed Record.",
"sig" : "(record)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the index within the cache of the Record with the passed id.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Inserts Records to the Store at the given index and fires the add event.",
"sig" : "(index, records)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
"sig" : "(options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
"sig" : "(data, append)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
"sig" : "(rec)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Query the records by a specified property.",
"sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
"sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
"sig" : "(options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove a Record from the Store and fires the remove event.",
"sig" : "(record)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove all Records from the Store and fires the clear event.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the default sort column and order to be used by the next load operation.",
"sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
"sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
"sig" : "(property, start, end)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.data.Tree" : {
+ "Roo.data.SortTypes" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "asDate",
+ "type" : "function",
+ "desc" : "Date sorting",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The comparison value"
+ }
+ ]
+ },
+ {
+ "name" : "asFloat",
+ "type" : "function",
+ "desc" : "Float sorting",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Float",
+ "desc" : "The comparison value"
+ }
+ ]
+ },
+ {
+ "name" : "asInt",
+ "type" : "function",
+ "desc" : "Integer sorting",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The comparison value"
+ }
+ ]
+ },
+ {
+ "name" : "asText",
+ "type" : "function",
+ "desc" : "Strips all HTML tags to sort on text only",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
+ },
+ {
+ "name" : "asUCString",
+ "type" : "function",
+ "desc" : "Case insensitive string",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
+ },
+ {
+ "name" : "asUCText",
+ "type" : "function",
+ "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
+ },
+ {
+ "name" : "none",
+ "type" : "function",
+ "desc" : "Default sort that does nothing",
+ "sig" : "(s)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "The comparison value"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.Store" : {
"props" : [
+ {
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf" : "Roo.data.Store"
+ },
+ {
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "Inline data to be loaded when the store is initialized.",
+ "memberOf" : "Roo.data.Store"
+ },
+ {
+ "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" : "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" : "[required] 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.DataReader",
+ "desc" : "[required] 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" : "append",
+ "name" : "add",
"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}",
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The newly appended node",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The array of Records added",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index of the newly appended node",
+ "desc" : "The index at which the record(s) were added",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeappend",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
+ "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" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be appended",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeinsert",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
- "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be inserted",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node is being inserted before",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforemove",
+ "name" : "clear",
"type" : "function",
- "desc" : "Fires before 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}",
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The node being moved",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The parent of the node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent the node is moving to",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "datachanged",
+ "type" : "function",
+ "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it is being moved to",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
+ "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" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be removed",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires when a new child node is inserted in a node in this tree.",
- "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
+ "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" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "",
+ "type" : "Proxy",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "return",
+ "type" : "Object",
+ "desc" : "from JsonData.reader() - success, totalRecords, records",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node inserted",
+ "name" : "load",
+ "type" : "Object",
+ "desc" : "options",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node was inserted before",
+ "name" : "jsonData",
+ "type" : "Object",
+ "desc" : "from your request (normally this contains the Exception)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "metachange",
"type" : "function",
- "desc" : "Fires when a node is moved to a new location in the tree",
- "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "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" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The node moved",
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "The JSON metadata",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The old parent of this node",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent of this node",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was removed",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index it was moved to",
+ "desc" : "The index at which the record was removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "update",
"type" : "function",
- "desc" : "Fires when a child node is removed from a node in this tree.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was updated",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node removed",
+ "name" : "operation",
+ "type" : "String",
+ "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
"isOptional" : false
}
],
}
],
"methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "clearFilter",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "If true the filter is cleared silently without notifying listeners",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getNodeById",
+ "name" : "collect",
"type" : "function",
- "desc" : "Gets a node in this tree by its id.",
- "sig" : "(id)",
+ "desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "dataIndex",
"type" : "String",
- "desc" : "",
+ "desc" : "The property to collect",
+ "isOptional" : false
+ },
+ {
+ "name" : "allowNull",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "isOptional" : false
+ },
+ {
+ "name" : "bypassFilter",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : ""
+ "type" : "Array",
+ "desc" : "An array of the unique values"
}
]
},
{
- "name" : "getRootNode",
+ "name" : "commitChanges",
"type" : "function",
- "desc" : "Returns the root node for this tree.",
+ "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" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "each",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "filter",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "field",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "A field on your records",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRootNode",
+ "name" : "filterBy",
"type" : "function",
- "desc" : "Sets the root node for this tree.",
- "sig" : "(node)",
+ "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" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
"returns" : []
- }
- ]
- },
- "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",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.data.DataReader",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "read",
+ "name" : "getAt",
"type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ "type" : "Roo.data.Record",
+ "desc" : "The Record at the passed index. Returns undefined if not found."
}
]
},
{
- "name" : "readRecords",
+ "name" : "getById",
"type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(doc)",
+ "desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "doc",
- "type" : "Object",
- "desc" : "A parsed XML document.",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ "type" : "Roo.data.Record",
+ "desc" : "The Record with the passed id. Returns undefined if not found."
}
]
- }
- ]
- },
- "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",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addInvalidHandleClass",
- "type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
- "isOptional" : false
- }
- ],
- "returns" : []
},
{
- "name" : "addInvalidHandleId",
+ "name" : "getCount",
"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" : "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" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "addInvalidHandleType",
+ "name" : "getModifiedRecords",
"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" : "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.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records containing outstanding modifications."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getRange",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) The starting index (defaults to 0)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "addToGroup",
- "type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "alignElWithMouse",
+ "name" : "getSortState",
"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 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" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
- "isOptional" : false
- },
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "applyConfig",
+ "name" : "getTotalCount",
"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" : "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.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "autoOffset",
+ "name" : "hasListener",
"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" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "cachePosition",
+ "name" : "indexOf",
"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" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Roo.data.Record object to to find.",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "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",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "clearTicks",
- "type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "endDrag",
- "type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the passed Record. Returns -1 if not found."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "id",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Number",
+ "desc" : "The index of the Record. Returns -1 if not found."
}
]
},
{
- "name" : "getDragEl",
+ "name" : "insert",
"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" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The start index at which to insert the passed Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "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.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
+ "name" : "append",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "init",
+ "name" : "loadDataFromChildren",
"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" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "rec",
+ "type" : "Object",
+ "desc" : "The record with a 'children array",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initTarget",
+ "name" : "on",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isLocked",
+ "name" : "purgeListeners",
"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" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
- }
- ]
+ "returns" : []
},
{
- "name" : "isTarget",
+ "name" : "query",
"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" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
},
{
- "name" : "isValidHandleChild",
+ "name" : "queryBy",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "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.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
}
]
},
{
- "name" : "lock",
+ "name" : "rejectChanges",
"type" : "function",
- "desc" : "Lock this instance",
+ "desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "on",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onAvailable",
+ "name" : "reload",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "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.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "onDrag",
+ "name" : "remove",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragDrop",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onDragEnter",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOut",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "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" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOver",
+ "name" : "sort",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "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" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onInvalidDrop",
+ "name" : "sum",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "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.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The sum"
+ }
+ ]
},
{
- "name" : "onMouseDown",
+ "name" : "un",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.data.Store" : [
+ "Roo.data.JsonStore",
+ "Roo.data.SimpleStore"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.Tree" : {
+ "props" : [
{
- "name" : "onMouseUp",
+ "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" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a new child node is appended to a node in this tree.",
+ "sig" : "function (tree, parent, node, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The newly appended node",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the newly appended node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "padding",
- "type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "purgeListeners",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires 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" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be appended",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "beforeinsert",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node is being inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeFromGroup",
+ "name" : "beforemove",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node being moved",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The parent of the node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent the node is moving to",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it is being moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "insert",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a new child node is inserted in a node in this tree.",
+ "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "move",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a node is moved to a new location in the tree",
+ "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node moved",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a child node is removed from a node in this tree.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node removed",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "resetConstraints",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "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",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "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",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDragElPos",
+ "name" : "fireEvent",
"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" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "setHandleElId",
+ "name" : "getNodeById",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "desc" : "Gets a node in this tree by its id.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "setInitPosition",
+ "name" : "getRootNode",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Returns the root node for this tree.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
- "isOptional" : false
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setOuterHandleElId",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "setPadding",
+ "name" : "on",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "purgeListeners",
"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" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setYConstraint",
+ "name" : "releaseCapture",
"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",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
- "isOptional" : false
- },
- {
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "toString",
+ "name" : "setRootNode",
"type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the root node for this tree.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "type" : "Node",
+ "desc" : ""
}
]
},
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.tree.TreePanel" : [
+ "Roo.tree.ColumnTree"
+ ],
+ "Roo.data.Tree" : [
+ "Roo.tree.TreePanel"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.XmlReader" : {
+ "props" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
+ "memberOf" : "Roo.data.XmlReader"
},
{
- "name" : "unlock",
+ "name" : "record",
+ "type" : "String",
+ "desc" : "The DomQuery path to the repeated element which contains record information.",
+ "memberOf" : "Roo.data.XmlReader"
+ },
+ {
+ "name" : "success",
+ "type" : "String",
+ "desc" : "The DomQuery path to the success attribute used by forms.",
+ "memberOf" : "Roo.data.XmlReader"
+ },
+ {
+ "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" : "Roo.data.XmlReader"
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.data.DataReader",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
+ }
+ ]
},
{
- "name" : "unreg",
+ "name" : "read",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
+ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
+ "sig" : "(response)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ }
+ ]
+ },
+ {
+ "name" : "readRecords",
+ "type" : "function",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(doc)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "doc",
+ "type" : "Object",
+ "desc" : "A parsed XML document.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
+ }
+ ]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.dd.DDProxy" : {
+ "Roo.dd" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.DD" : {
"props" : [
{
"name" : "listeners",
"desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
"sig" : "(el, iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
"sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
"sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "createFrame",
- "type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "endDrag",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initFrame",
- "type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "initTarget",
"type" : "function",
"desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
"sig" : "(iDeltaX, iDeltaY)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
"sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.dd.DDProxy" : [
+ "Roo.dd.DragSource",
+ "Roo.grid.SplitDragZone"
+ ],
+ "Roo.dd.DD" : [
+ "Roo.dd.DDProxy"
+ ],
+ "Roo.dd.DragSource" : [
+ "Roo.dd.DragZone"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "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" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleId",
+ "type" : "function",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleType",
+ "type" : "function",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "unlock",
- "type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "unreg",
- "type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ]
- },
- "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",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "object",
+ "name" : "options",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
"static" : false,
"memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleId",
+ "name" : "alignElWithMouse",
"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 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.DragDrop",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addInvalidHandleType",
+ "name" : "applyConfig",
"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" : "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",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "autoOffset",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "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.util.Observable",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addToGroup",
+ "name" : "cachePosition",
"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" : "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.DragDrop",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
+ "name" : "iPageX",
"type" : "",
- "desc" : "{string} the name of the group",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "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",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "createFrame",
+ "type" : "function",
+ "desc" : "Creates the proxy element if it does not yet exist",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "endDrag",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initFrame",
+ "type" : "function",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "initTarget",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setDelta",
+ "type" : "function",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDragElId",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setDragElPos",
+ "type" : "function",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setHandleElId",
"type" : "function",
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.dd.DDProxy" : [
+ "Roo.dd.DragSource",
+ "Roo.grid.SplitDragZone"
+ ],
+ "Roo.dd.DragSource" : [
+ "Roo.dd.DragZone"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.dd.DragDrop" : {
+ "Roo.dd.DDTarget" : {
"props" : [
{
"name" : "listeners",
"desc" : "Lets you specify a css class of elements that will not initiate a drag",
"sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
"sig" : "(tagName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
"sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Fired when we are done dragging the object",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a reference to the linked element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Checks the tag exclusion list to see if this click should be ignored",
"sig" : "(node)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Lock this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when we are no longer hovering over an element",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove's this instance from the supplied interaction group",
"sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid css class",
"sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid handle id",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an excluded tag name set by addInvalidHandleType",
"sig" : "(tagName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "resetConstraints must be called if you manually reposition a dd element.",
"sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Stores the initial placement of the linked element.",
"sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
"sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
"sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
"sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
"sig" : "(X, Y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "toString method",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.dd.DropTarget" : [
+ "Roo.dd.DropZone"
+ ],
+ "Roo.dd.DDTarget" : [
+ "Roo.dd.DropTarget"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "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",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleId",
+ "type" : "function",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleType",
+ "type" : "function",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "clearTicks",
+ "type" : "function",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "initTarget",
+ "type" : "function",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ }
+ ]
+ },
+ {
+ "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" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValidHandleChild",
+ "type" : "function",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
+ }
+ ]
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unlock",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Unlock this instace",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "unreg",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- }
- ]
- },
- "Roo.dd.DragDropMgr" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "getBestMatch",
+ "name" : "onDragDrop",
"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" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "dds",
- "type" : "DragDrop[]",
- "desc" : "The array of drag and drop objects\ntargeted",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "DragDrop",
- "desc" : "The best single match"
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getCss",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)",
- "sig" : "(id)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: use Roo.getDom instead",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
{
"name" : "id",
- "type" : "String",
- "desc" : "the id of the elment to get",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The style property of the element"
- }
- ]
+ "returns" : []
},
{
- "name" : "getDDById",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Returns the DragDrop instance for a given id",
- "sig" : "(id)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
{
"name" : "id",
- "type" : "String",
- "desc" : "the id of the DragDrop object",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "DragDrop",
- "desc" : "the drag drop object, null if it is not found"
- }
- ]
+ "returns" : []
},
{
- "name" : "getElement",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Returns the actual DOM element",
- "sig" : "(id)",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: use Roo.getDom instead",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
{
"name" : "id",
- "type" : "String",
- "desc" : "the id of the elment to get",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The element"
- }
- ]
+ "returns" : []
},
{
- "name" : "getLocation",
+ "name" : "onInvalidDrop",
"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" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "oDD",
- "type" : "DragDrop",
- "desc" : "the drag and drop object to get the\n location for",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.lib.Region",
- "desc" : "a Region object representing the total area\n the element occupies, including any padding\n the instance is configured for."
- }
- ]
+ "returns" : []
},
{
- "name" : "getPosX",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Returns the X position of an html element",
- "sig" : "(el)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: use Roo.lib.Dom.getX instead",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "",
- "desc" : "the element for which to get the position",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "int",
- "desc" : "the X coordinate"
- }
- ]
+ "returns" : []
},
{
- "name" : "getPosY",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Returns the Y position of an html element",
- "sig" : "(el)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: use Roo.lib.Dom.getY instead",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "",
- "desc" : "the element for which to get the position",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "int",
- "desc" : "the Y coordinate"
- }
- ]
+ "returns" : []
},
{
- "name" : "getRelated",
+ "name" : "padding",
"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" : "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" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "p_oDD",
- "type" : "DragDrop",
- "desc" : "the obj to get related data for",
- "isOptional" : false
- },
- {
- "name" : "bTargetsOnly",
- "type" : "boolean",
- "desc" : "if true, only return targetable objs",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "DragDrop[]",
- "desc" : "the related instances"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getScrollLeft",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Gets the scrollLeft",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "int",
- "desc" : "the document's scrollTop"
- }
- ]
+ "returns" : []
},
{
- "name" : "getScrollTop",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Gets the scrollTop",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "int",
- "desc" : "the document's scrollTop"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getStyle",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Returns the specified element style property",
- "sig" : "(el, styleProp)",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: use Roo.lib.Dom.getStyle",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element",
- "isOptional" : false
- },
- {
- "name" : "styleProp",
+ "name" : "sGroup",
"type" : "string",
- "desc" : "the style property",
+ "desc" : "The group to drop",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "string",
- "desc" : "The value of the style property"
- }
- ]
+ "returns" : []
},
{
- "name" : "handleWasClicked",
+ "name" : "removeInvalidHandleClass",
"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" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "",
- "desc" : "the html element to inspect",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isDragDrop",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop item.",
+ "desc" : "Unsets an invalid handle id",
"sig" : "(id)",
"static" : false,
"memberOf" : "",
"params" : [
{
"name" : "id",
- "type" : "String",
- "desc" : "the element id to check",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this element is a DragDrop item,\nfalse otherwise"
- }
- ]
+ "returns" : []
},
{
- "name" : "isHandle",
+ "name" : "removeInvalidHandleType",
"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" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "the element id to check",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this element is a DragDrop handle, false\notherwise"
- }
- ]
+ "returns" : []
},
{
- "name" : "isLegalTarget",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Returns true if the specified dd target is a legal target for\nthe specifice drag obj",
- "sig" : "(the, the)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "DragDrop",
- "desc" : "drag obj",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "the",
- "type" : "DragDrop",
- "desc" : "target",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "boolean",
- "desc" : "true if the target is a legal target for the\ndd obj"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isLocked",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Is drag and drop locked?",
- "sig" : "()\n{\n\n}",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "maintainOffset",
"type" : "boolean",
- "desc" : "True if drag and drop is locked, false otherwise."
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isTypeOfDD",
+ "name" : "setDragElId",
"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" : "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" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "the",
- "type" : "Object",
- "desc" : "object to evaluate",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if typeof oDD = DragDrop"
- }
- ]
+ "returns" : []
},
{
- "name" : "lock",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Lock all drag and drop functionality",
- "sig" : "()\n{\n\n}",
+ "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" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "moveToEl",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Sets the x/y position of an element to the location of the\ntarget element.",
- "sig" : "(moveEl, targetEl)",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "moveEl",
- "type" : "HTMLElement",
- "desc" : "The element to move",
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
"isOptional" : false
},
{
- "name" : "targetEl",
- "type" : "HTMLElement",
- "desc" : "The position reference element",
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "numericSort",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Numeric array sort function",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "refreshCache",
+ "name" : "setPadding",
"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" : "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" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "groups",
- "type" : "Object",
- "desc" : "an associative array of groups to refresh",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regDragDrop",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()",
- "sig" : "(oDD, sGroup)",
+ "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" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "oDD",
- "type" : "DragDrop",
- "desc" : "the DragDrop object to register",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the name of the group this element belongs to",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regHandle",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()",
- "sig" : "(sDDId, sHandleId)",
+ "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" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "sDDId",
- "type" : "String",
- "desc" : "the DragDrop id this element is a handle for",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
"isOptional" : false
},
{
- "name" : "sHandleId",
- "type" : "String",
- "desc" : "the id of the element that is the drag\nhandle",
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
{
"name" : "startDrag",
"type" : "function",
- "desc" : "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met.",
- "sig" : "(x, y)",
+ "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" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "",
- "desc" : "{int} the X position of the original mousedown",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "",
- "desc" : "{int} the Y position of the original mousedown",
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "stopEvent",
+ "name" : "toString",
"type" : "function",
- "desc" : "Utility to stop event propagation and event default, if these\nfeatures are turned on.",
- "sig" : "(e)",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the event as returned by this.getEvent()",
- "isOptional" : false
+ "name" : "",
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "swapNode",
+ "name" : "un",
"type" : "function",
- "desc" : "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior",
- "sig" : "(n1, n2)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "n1",
- "type" : "",
- "desc" : "the first node to swap",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "n2",
- "type" : "",
- "desc" : "the other node to swap",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
{
"name" : "unlock",
"type" : "function",
- "desc" : "Unlock all drag and drop functionality",
+ "desc" : "Unlock this instace",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "verifyEl",
+ "name" : "unreg",
"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" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to check",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if the element looks usable"
- }
- ]
+ "params" : [],
+ "returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.dd.DragDrop" : [
+ "Roo.dd.DD",
+ "Roo.dd.DDTarget"
+ ],
+ "Roo.dd.DDProxy" : [
+ "Roo.dd.DragSource",
+ "Roo.grid.SplitDragZone"
+ ],
+ "Roo.dd.DD" : [
+ "Roo.dd.DDProxy"
+ ],
+ "Roo.dd.DDTarget" : [
+ "Roo.dd.DropTarget"
+ ],
+ "Roo.dd.DropTarget" : [
+ "Roo.dd.DropZone"
+ ],
+ "Roo.dd.DragSource" : [
+ "Roo.dd.DragZone"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"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" : ""
+ "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" : ""
+ "memberOf" : "Roo.dd.DragSource"
},
{
"name" : "listeners",
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.dd.DragSource" : [
+ "Roo.dd.DragZone"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.dd.DragZone" : {
"props" : [
"name" : "containerScroll",
"type" : "Boolean",
"desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
- "memberOf" : ""
+ "memberOf" : "Roo.dd.DragZone"
},
{
"name" : "dropAllowed",
"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" : ""
+ "memberOf" : "Roo.dd.DragZone"
},
{
"name" : "listeners",
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.dd.DropTarget" : {
"props" : [
"name" : "ddGroup",
"type" : "String",
"desc" : "The drag drop group to handle drop events for",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "Roo.dd.DropTarget"
},
{
"name" : "listeners",
"name" : "overClass",
"type" : "String",
"desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf" : ""
+ "memberOf" : "Roo.dd.DropTarget"
},
{
"name" : "success",
"type" : "boolean",
"desc" : "set this after drop listener..",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "Roo.dd.DropTarget"
}
],
"events" : [
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.dd.DropTarget" : [
+ "Roo.dd.DropZone"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.dd.DropZone" : {
"props" : [
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.dd.Registry" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.dd.ScrollManager" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.dd.StatusProxy" : {
"props" : [
"name" : "dropAllowed",
"type" : "String",
"desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : ""
+ "memberOf" : "Roo.dd.StatusProxy"
},
{
"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" : ""
+ "memberOf" : "Roo.dd.StatusProxy"
}
],
"events" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.Action" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.BasicForm" : {
"props" : [
"name" : "baseParams",
"type" : "Object",
"desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "errorMask",
"type" : "Boolean",
"desc" : "e) default false",
- "memberOf" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"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" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "fileUpload",
"type" : "Boolean",
"desc" : "Set to true if this form is a file upload.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "listeners",
"name" : "maskOffset",
"type" : "Number",
"desc" : "Default 100",
- "memberOf" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"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" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"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" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "timeout",
"type" : "Number",
"desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"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" : ""
+ "memberOf" : "Roo.form.BasicForm"
},
{
"name" : "url",
"type" : "String",
"desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.BasicForm"
}
],
"events" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.form.BasicForm" : [
+ "Roo.form.Form"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.Checkbox" : {
"props" : [
"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" : ""
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "boxLabel",
"type" : "String",
"desc" : "The text that appears beside the checkbox",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "checked",
"type" : "Boolean",
"desc" : "True if the the checkbox should render already checked (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "cls",
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "fieldLabel",
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "height",
"name" : "inputValue",
"type" : "String",
"desc" : "The value that should go into the generated input element's value attribute",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "invalidClass",
"name" : "valueOff",
"type" : "String",
"desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Checkbox"
},
{
"name" : "width",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.form.Checkbox" : [
+ "Roo.form.Radio"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.Column" : {
"props" : [
"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" : ""
+ "memberOf" : "Roo.form.Column"
},
{
"name" : "clear",
"name" : "width",
"type" : "Number/String",
"desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Column"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.ComboBox" : {
"props" : [
"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",
"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",
"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",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.form.ComboBox" : [
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.ComboBoxArray" : {
"props" : [
"name" : "combo",
"type" : "Roo.form.ComboBox",
"desc" : "[required] The combo box that is wrapped",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBoxArray"
},
{
"name" : "disableClass",
"name" : "hiddenName",
"type" : "String",
"desc" : "The hidden name of the field, often contains an comma seperated list of names",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBoxArray"
},
{
"name" : "hideMode",
"name" : "name",
"type" : "String",
"desc" : "The name of the visable items on this form (eg. titles not ids)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBoxArray"
},
{
"name" : "qtip",
"name" : "seperator",
"type" : "String",
"desc" : "The value seperator normally ','",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBoxArray"
},
{
"name" : "tabIndex",
"name" : "width",
"type" : "Number",
"desc" : "The width of the box that displays the selected element",
- "memberOf" : ""
+ "memberOf" : "Roo.form.ComboBoxArray"
}
],
"events" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.ComboBoxArray.Item" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.ComboCheck" : {
"props" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.ComboNested" : {
"props" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.DateField" : {
"props" : [
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"name" : "blankText",
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"name" : "disabledDatesText",
"type" : "String",
"desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"name" : "disabledDaysText",
"type" : "String",
"desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"name" : "emptyText",
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"name" : "height",
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"name" : "listeners",
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"name" : "minLength",
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"name" : "msgFx",
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.DateField"
},
{
"name" : "validateOnBlur",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.DayPicker" : {
"props" : [
"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" : ""
+ "memberOf" : "Roo.form.DayPicker"
},
{
"name" : "cls",
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.DayPicker"
},
{
"name" : "fieldLabel",
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.DayPicker"
},
{
"name" : "height",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.DisplayField" : {
"props" : [
"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" : ""
+ "memberOf" : "Roo.form.DisplayField"
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "e) default false",
- "memberOf" : ""
+ "memberOf" : "Roo.form.DisplayField"
},
{
"name" : "cls",
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.DisplayField"
},
{
"name" : "fieldLabel",
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.DisplayField"
},
{
"name" : "height",
"name" : "valueRenderer",
"type" : "Function",
"desc" : "The renderer for the field (so you can reformat output). should return raw HTML",
- "memberOf" : ""
+ "memberOf" : "Roo.form.DisplayField"
},
{
"name" : "width",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.FCKeditor" : {
"props" : [
"name" : "fck",
"type" : "Object",
"desc" : "BasePath",
- "memberOf" : ""
+ "memberOf" : "Roo.form.FCKeditor"
},
{
"name" : "fieldClass",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.Field" : {
"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" : ""
+ "memberOf" : "Roo.form.Field"
},
{
"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",
"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",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.form.Field" : [
+ "Roo.form.Checkbox",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.GridField",
+ "Roo.form.HtmlEditor",
+ "Roo.form.Signature",
+ "Roo.form.TextField"
+ ],
+ "Roo.form.TextArea" : [
+ "Roo.form.FCKeditor"
+ ],
+ "Roo.form.Checkbox" : [
+ "Roo.form.Radio"
+ ],
+ "Roo.form.TextField" : [
+ "Roo.form.ComboBoxArray",
+ "Roo.form.Hidden",
+ "Roo.form.NumberField",
+ "Roo.form.TextArea",
+ "Roo.form.TriggerField"
+ ],
+ "Roo.form.TriggerField" : [
+ "Roo.form.ComboBox",
+ "Roo.form.DateField",
+ "Roo.form.MonthField",
+ "Roo.form.Select"
+ ],
+ "Roo.form.ComboBox" : [
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.FieldSet" : {
"props" : [
"name" : "autoCreate",
"type" : "String/Object",
"desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
- "memberOf" : ""
+ "memberOf" : "Roo.form.FieldSet"
},
{
"name" : "clear",
"name" : "legend",
"type" : "String",
"desc" : "The text to display as the legend for the FieldSet (defaults to '')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.FieldSet"
},
{
"name" : "listeners",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem"
+ ],
+ "tree_parent" : []
},
"Roo.form.Form" : {
"props" : [
"name" : "buttonAlign",
"type" : "String",
"desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"name" : "buttons[]",
"type" : "Roo.Button",
"desc" : "buttons at bottom of form",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"name" : "errorMask",
"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" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"name" : "itemCls",
"type" : "String",
"desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"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" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "The width of labels. This property cascades to child containers.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"name" : "listeners",
"name" : "minButtonWidth",
"type" : "Number",
"desc" : "Minimum width of all buttons in pixels (defaults to 75)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"name" : "monitorPoll",
"type" : "Number",
"desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"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" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"name" : "progressUrl",
"type" : "String",
"desc" : "- Url to return progress data",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Form"
},
{
"name" : "reader",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.FieldSet",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem"
+ ],
+ "tree_parent" : []
},
"Roo.form.GridField" : {
"props" : [
"name" : "addTitle",
"type" : "String",
"desc" : "Text to include for adding a title.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.GridField"
},
{
"name" : "allowDomMove",
"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" : ""
+ "memberOf" : "Roo.form.GridField"
},
{
"name" : "cls",
"name" : "height",
"type" : "Number",
"desc" : "- used to restrict height of grid..",
- "memberOf" : ""
+ "memberOf" : "Roo.form.GridField"
},
{
"name" : "hideMode",
"name" : "width",
"type" : "Number",
"desc" : "- used to restrict width of grid..",
- "memberOf" : ""
+ "memberOf" : "Roo.form.GridField"
},
{
"name" : "xgrid",
"type" : "Object",
"desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
- "memberOf" : ""
+ "memberOf" : "Roo.form.GridField"
}
],
"events" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.Hidden" : {
"props" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.HtmlEditor" : {
"props" : [
"name" : "allowComments",
"type" : "boolean",
"desc" : "- default false - allow comments in HTML source - by default they are stripped - if you are editing email you may need this.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor"
},
{
"name" : "allowDomMove",
"name" : "blacklist",
"type" : "Array",
"desc" : "of html tags - in addition to standard blacklist.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor"
},
{
"name" : "clearUp",
"type" : "Boolean",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor"
},
{
"name" : "cls",
"name" : "height",
"type" : "Number",
"desc" : "(in pixels)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor"
},
{
"name" : "hideMode",
"name" : "resizable",
"type" : "String",
"desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor"
},
{
"name" : "stylesheets",
"type" : "Array",
"desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor"
},
{
"name" : "tabIndex",
"name" : "toolbars",
"type" : "Array",
"desc" : "Array of toolbars. - defaults to just the Standard one",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor"
},
{
"name" : "validationDelay",
"name" : "whitelist",
"type" : "Array",
"desc" : "of html tags - in addition to statndard whitelist",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor"
},
{
"name" : "width",
"type" : "Number",
"desc" : "(in pixels)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor"
}
],
"events" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.HtmlEditor.ToolbarContext" : {
"props" : [
"name" : "disable",
"type" : "Object",
"desc" : "List of toolbar elements to disable",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor.ToolbarContext"
},
{
"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" : ""
+ "memberOf" : "Roo.form.HtmlEditor.ToolbarContext"
}
],
"events" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"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; }",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard"
},
{
"name" : "createLinkText",
"type" : "String",
"desc" : "The default text for the create link prompt",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard"
},
{
"name" : "defaultFont",
"type" : "String",
"desc" : "default font to use.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard"
},
{
"name" : "defaultLinkValue",
"type" : "String",
"desc" : "The default value for the create link prompt (defaults to http:/ /)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard"
},
{
"name" : "disable",
"type" : "Object",
"desc" : "List of elements to disable..",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard"
},
{
"name" : "fontFamilies",
"type" : "Array",
"desc" : "An array of available font families",
- "memberOf" : ""
+ "memberOf" : "Roo.form.HtmlEditor.ToolbarStandard"
}
],
"events" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.Layout" : {
"props" : [
"name" : "autoCreate",
"type" : "String/Object",
"desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "disableClass",
"name" : "hideLabels",
"type" : "Boolean",
"desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "hideMode",
"name" : "labelAlign",
"type" : "String",
"desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "labelSeparator",
"type" : "String",
"desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Layout"
},
{
"name" : "listeners",
"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" : ""
+ "memberOf" : "Roo.form.Layout"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.form.Layout" : [
+ "Roo.form.Column",
+ "Roo.form.FieldSet",
+ "Roo.form.Row"
+ ]
+ },
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem"
+ ],
+ "tree_parent" : []
},
"Roo.form.MonthField" : {
"props" : [
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"name" : "blankText",
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"name" : "disabledDatesText",
"type" : "String",
"desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"name" : "disabledDaysText",
"type" : "String",
"desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"name" : "emptyText",
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"name" : "height",
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"name" : "listeners",
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"name" : "minLength",
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"name" : "msgFx",
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.MonthField"
},
{
"name" : "validateOnBlur",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.NumberField" : {
"props" : [
"name" : "allowDecimals",
"type" : "Boolean",
"desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "allowDomMove",
"name" : "allowNegative",
"type" : "Boolean",
"desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "autoCreate",
"name" : "decimalPrecision",
"type" : "Number",
"desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "decimalSeparator",
"type" : "String",
"desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "disableClass",
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "fieldLabel",
"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" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "maxValue",
"type" : "Number",
"desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "minLength",
"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" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "minValue",
"type" : "Number",
"desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "msgFx",
"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" : ""
+ "memberOf" : "Roo.form.NumberField"
},
{
"name" : "qtip",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.Radio" : {
"props" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.Row" : {
"props" : [
"name" : "height",
"type" : "Number/String",
"desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Row"
},
{
"name" : "hideLabels",
"name" : "width",
"type" : "Number/String",
"desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Row"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem"
+ ],
+ "tree_parent" : []
},
"Roo.form.Select" : {
"props" : [
"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.Select"
},
{
"name" : "allowBlank",
"name" : "alwaysQuery",
"type" : "Boolean",
"desc" : "Disable caching of results, and always send query",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"name" : "cls",
"name" : "defaultValue",
"type" : "String",
"desc" : "The value displayed after loading the store.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"name" : "disableClass",
"name" : "disableClear",
"type" : "Boolean",
"desc" : "Disable showing of clear button.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"name" : "grow",
"type" : "Boolean",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"name" : "growMax",
"type" : "Number",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"name" : "hideMode",
"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.Select"
},
{
"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.Select"
},
{
"name" : "listClass",
"type" : "String",
"desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"name" : "queryParam",
"type" : "String",
"desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"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.Select"
},
{
"name" : "tpl",
"type" : "String/Roo.Template",
"desc" : "The template to use to render the output",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"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.Select"
},
{
"name" : "vtype",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.Signature" : {
"props" : [
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Signature"
},
{
"name" : "allowDomMove",
"name" : "height",
"type" : "Number",
"desc" : "The signature panel height (defaults to 100)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Signature"
},
{
"name" : "hideMode",
"name" : "labels",
"type" : "Object",
"desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Signature"
},
{
"name" : "listeners",
"name" : "width",
"type" : "Number",
"desc" : "The signature panel width (defaults to 300)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Signature"
}
],
"events" : [
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.TextArea" : {
"props" : [
"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" : ""
+ "memberOf" : "Roo.form.TextArea"
},
{
"name" : "blankText",
"name" : "growMax",
"type" : "Number",
"desc" : "The maximum height to allow when grow = true (defaults to 1000)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextArea"
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "The minimum height to allow when grow = true (defaults to 60)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextArea"
},
{
"name" : "height",
"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" : ""
+ "memberOf" : "Roo.form.TextArea"
},
{
"name" : "qtip",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.form.TextArea" : [
+ "Roo.form.FCKeditor"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.TextField" : {
"props" : [
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "allowDomMove",
"name" : "allowLeadingSpace",
"type" : "Boolean",
"desc" : "True to prevent the stripping of leading white space",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "autoCreate",
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "cls",
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "disabled",
"name" : "emptyText",
"type" : "String",
"desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "fieldClass",
"name" : "grow",
"type" : "Boolean",
"desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "growMax",
"type" : "Number",
"desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "height",
"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" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "msgFx",
"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" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"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" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "value",
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextField"
},
{
"name" : "width",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.form.TextArea" : [
+ "Roo.form.FCKeditor"
+ ],
+ "Roo.form.TextField" : [
+ "Roo.form.ComboBoxArray",
+ "Roo.form.Hidden",
+ "Roo.form.NumberField",
+ "Roo.form.TextArea",
+ "Roo.form.TriggerField"
+ ],
+ "Roo.form.ComboBox" : [
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested"
+ ],
+ "Roo.form.TriggerField" : [
+ "Roo.form.ComboBox",
+ "Roo.form.DateField",
+ "Roo.form.MonthField",
+ "Roo.form.Select"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.TextItem" : {
"props" : [
"name" : "html",
"type" : "String",
"desc" : "the content for this item",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextItem"
},
{
"name" : "listeners",
"name" : "tag",
"type" : "String",
"desc" : "the tag for this item (default div)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TextItem"
},
{
"name" : "width",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.TriggerField" : {
"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: \"16\", autocomplete: \"off\"})",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TriggerField"
},
{
"name" : "blankText",
"name" : "hideTrigger",
"type" : "Boolean",
"desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.TriggerField"
},
{
"name" : "inputType",
"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" : ""
+ "memberOf" : "Roo.form.TriggerField"
},
{
"name" : "validateOnBlur",
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.form.ComboBox" : [
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested"
+ ],
+ "Roo.form.TriggerField" : [
+ "Roo.form.ComboBox",
+ "Roo.form.DateField",
+ "Roo.form.MonthField",
+ "Roo.form.Select"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.form.VTypes" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.AbstractGridView" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.AbstractSelectionModel" : {
"props" : [
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.grid.AbstractSelectionModel" : [
+ "Roo.grid.CellSelectionModel",
+ "Roo.grid.RowSelectionModel"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.Calendar" : {
"props" : [
+ {
+ "name" : "autoExpandColumn",
+ "type" : "String",
+ "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "autoExpandMax",
+ "type" : "Number",
+ "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "autoExpandMin",
+ "type" : "Number",
+ "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "autoHeight",
+ "type" : "Boolean",
+ "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "autoSizeColumns",
+ "type" : "Boolean",
+ "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "autoSizeHeaders",
+ "type" : "Boolean",
+ "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "autoWidth",
+ "type" : "Boolean",
+ "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "The columns of the grid",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "- drag drop group.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "ddText",
+ "type" : "String",
+ "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "dragGroup",
+ "type" : "String",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "dropTarget",
+ "type" : "Roo.dd.DropTarget",
+ "desc" : "An {@link Roo.dd.DropTarget} config",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "ds",
+ "type" : "Roo.grid.Store",
+ "desc" : "The data store for the grid",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "enableColumnHide",
+ "type" : "Boolean",
+ "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "enableColumnMove",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "enableDrag",
+ "type" : "Boolean",
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "enableDragDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop of rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "enableRowHeightSync",
+ "type" : "Boolean",
+ "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid"
+ },
{
"name" : "eventStore",
"type" : "Store",
"desc" : "The store that loads events.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Calendar"
+ },
+ {
+ "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" : "Object",
+ "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "maxRowsToMeasure",
+ "type" : "Boolean",
+ "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "The minimum width a column can be resized to. Default is 25.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "monitorWindowResize",
+ "type" : "Boolean",
+ "desc" : "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "stripeRows",
+ "type" : "Boolean",
+ "desc" : "True to stripe the rows. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "a toolbar for buttons etc.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "trackMouseOver",
+ "type" : "Boolean",
+ "desc" : "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf" : "Roo.grid.Grid"
+ },
+ {
+ "name" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "Roo.grid.Grid"
}
],
"events" : [
}
],
"methods" : [
+ {
+ "name" : "addColumns",
+ "type" : "function",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
+ "isOptional" : false
+ },
+ {
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "getColumnModel",
+ "type" : "function",
+ "desc" : "Returns the grid's ColumnModel.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "ColumnModel",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getDataSource",
+ "type" : "function",
+ "desc" : "Returns the grid's DataSource.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "DataSource",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getDragDropText",
+ "type" : "function",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getGridEl",
+ "type" : "function",
+ "desc" : "Returns the grid's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
+ }
+ ]
+ },
{
"name" : "getSelectionModel",
"type" : "function",
"desc" : ""
}
]
+ },
+ {
+ "name" : "getView",
+ "type" : "function",
+ "desc" : "Returns the grid's GridView object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "GridView",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "reconfigure",
+ "type" : "function",
+ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The new {@link Roo.data.Store} object",
+ "isOptional" : false
+ },
+ {
+ "name" : "The",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.grid.Grid",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.CellSelectionModel" : {
"props" : [
"name" : "enter_is_tab",
"type" : "Boolean",
"desc" : "Enter behaves the same as tab. (eg. goes to next cell) default: false",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.CellSelectionModel"
},
{
"name" : "listeners",
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.ColumnModel" : {
"props" : [
"name" : "align",
"type" : "String",
"desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "cursor",
"type" : "String",
"desc" : "(Optional)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "dataIndex",
"type" : "String",
"desc" : "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "editor",
"type" : "Roo.grid.GridEditor",
"desc" : "(Optional) For grid editors - returns the grid editor",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "fixed",
"type" : "Boolean",
"desc" : "(Optional) True if the column width cannot be changed. Defaults to false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "header",
"type" : "String",
"desc" : "The header text to display in the Grid view.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "(Optional) True to hide the column. Defaults to false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "lg",
"type" : "Number",
"desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "lgHeader",
"type" : "String",
"desc" : "Header at Bootsrap Large width",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "listeners",
"name" : "locked",
"type" : "Boolean",
"desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "md",
"type" : "Number",
"desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "mdHeader",
"type" : "String",
"desc" : "Header at Bootsrap Medium width",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "renderer",
"type" : "Function",
"desc" : "(Optional) A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "resizable",
"type" : "Boolean",
"desc" : "(Optional) False to disable column resizing. Defaults to true.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "sm",
"type" : "Number",
"desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "smHeader",
"type" : "String",
"desc" : "Header at Bootsrap Small width",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "sortable",
"type" : "Boolean",
"desc" : "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "tooltip",
"type" : "String",
"desc" : "(Optional)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "valign",
"type" : "String",
"desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "width",
"type" : "Number",
"desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "xl",
"type" : "Number",
"desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "xlHeader",
"type" : "String",
"desc" : "Header at Bootsrap extra Large width",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "xs",
"type" : "Number",
"desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
},
{
"name" : "xsHeader",
"type" : "String",
"desc" : "Header at Bootsrap Extra Small width (default for all)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.ColumnModel"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.EditorGrid" : {
"props" : [
"name" : "clicksToEdit",
"type" : "Number",
"desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.EditorGrid"
},
{
"name" : "cm[]",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.grid.EditorGrid" : [
+ "Roo.grid.PropertyGrid"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.Grid" : {
"props" : [
"name" : "autoExpandColumn",
"type" : "String",
"desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "autoExpandMax",
"type" : "Number",
"desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "autoExpandMin",
"type" : "Number",
"desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "autoHeight",
"type" : "Boolean",
"desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "autoSizeColumns",
"type" : "Boolean",
"desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "autoSizeHeaders",
"type" : "Boolean",
"desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "autoWidth",
"type" : "Boolean",
"desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "cm[]",
"type" : "Roo.grid.ColumnModel",
"desc" : "The columns of the grid",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "- drag drop group.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "ddText",
"type" : "String",
"desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "dragGroup",
"type" : "String",
"desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "dropTarget",
"type" : "Roo.dd.DropTarget",
"desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "ds",
"type" : "Roo.grid.Store",
"desc" : "The data store for the grid",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "enableColumnHide",
"type" : "Boolean",
"desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "enableColumnMove",
"type" : "Boolean",
"desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "enableDrag",
"type" : "Boolean",
"desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "enableDragDrop",
"type" : "Boolean",
"desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "enableDrop",
"type" : "Boolean",
"desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "enableRowHeightSync",
"type" : "Boolean",
"desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "listeners",
"name" : "loadMask",
"type" : "Object",
"desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "maxHeight",
"type" : "Number",
"desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "maxRowsToMeasure",
"type" : "Boolean",
"desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "minColumnWidth",
"type" : "Number",
"desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "monitorWindowResize",
"type" : "Boolean",
"desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "sm",
"type" : "Roo.grid.AbstractSelectionModel",
"desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "stripeRows",
"type" : "Boolean",
"desc" : "True to stripe the rows. Default is true.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "a toolbar for buttons etc.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "trackMouseOver",
"type" : "Boolean",
"desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
},
{
"name" : "view",
"type" : "Roo.grid.GridView",
"desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.Grid"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.grid.EditorGrid" : [
+ "Roo.grid.PropertyGrid"
+ ],
+ "Roo.grid.Grid" : [
+ "Roo.grid.Calendar",
+ "Roo.grid.EditorGrid"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.GridEditor" : {
"props" : [
"name" : "field",
"type" : "Roo.form.Field",
"desc" : "Field to wrap (or xtyped)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.GridEditor"
},
{
"name" : "hideEl",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.GridView" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.PropertyGrid" : {
"props" : [
"name" : "customEditors",
"type" : "Object",
"desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.PropertyGrid"
},
{
"name" : "ddGroup",
"name" : "propertyNames",
"type" : "Object",
"desc" : "map of property Names to their displayed value",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.PropertyGrid"
},
{
"name" : "sm",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.RowSelectionModel" : {
"props" : [
"name" : "singleSelect",
"type" : "Boolean",
"desc" : "True to allow selection of only one row at a time (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.grid.RowSelectionModel"
}
],
"events" : [
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.grid.SplitDragZone" : {
"props" : [
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.lib" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.lib.Ajax" : {
"props" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.lib.Dom" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu.Adapter" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.menu.Adapter" : [
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu.BaseItem" : {
"props" : [
"name" : "activeClass",
"type" : "String",
"desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "allowDomMove",
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "disableClass",
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "hideMode",
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.BaseItem"
},
{
"name" : "listeners",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.menu.BaseItem" : [
+ "Roo.menu.Adapter",
+ "Roo.menu.Item",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem"
+ ],
+ "Roo.menu.Adapter" : [
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem"
+ ],
+ "Roo.menu.Item" : [
+ "Roo.menu.CheckItem"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu.CheckItem" : {
"props" : [
"name" : "checked",
"type" : "Boolean",
"desc" : "True to initialize this checkbox as checked (defaults to false). Note that\nif this checkbox is part of a radio group (group = true) only the last item in the group that is\ninitialized with checked = true will be rendered as checked.",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.CheckItem"
},
{
"name" : "disableClass",
"name" : "group",
"type" : "String",
"desc" : "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.CheckItem"
},
{
"name" : "groupClass",
"type" : "String",
"desc" : "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.CheckItem"
},
{
"name" : "handler",
"name" : "itemCls",
"type" : "String",
"desc" : "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.CheckItem"
},
{
"name" : "listeners",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu.ColorItem" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu.ColorMenu" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu.DateItem" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu.DateMenu" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu.Item" : {
"props" : [
"name" : "HTML",
"type" : "String",
"desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Item"
},
{
"name" : "actionMode",
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Item"
},
{
"name" : "disableClass",
"name" : "icon",
"type" : "String",
"desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Item"
},
{
"name" : "itemCls",
"type" : "String",
"desc" : "The default CSS class to use for menu items (defaults to \"x-menu-item\")",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Item"
},
{
"name" : "listeners",
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "A Sub menu",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Item"
},
{
"name" : "showDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Item"
},
{
"name" : "text",
"type" : "String",
"desc" : "The text to show on the menu item.",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Item"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.menu.Item" : [
+ "Roo.menu.CheckItem"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.menu.Menu" : {
"props" : [
"name" : "allowOtherMenus",
"type" : "Boolean",
"desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Menu"
},
{
"name" : "defaultAlign",
"type" : "String",
"desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Menu"
},
{
"name" : "listeners",
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width of the menu in pixels (defaults to 120)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Menu"
},
{
"name" : "registerMenu",
"type" : "Boolean",
"desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Menu"
},
{
"name" : "shadow",
"type" : "Boolean/String",
"desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Menu"
},
{
"name" : "subMenuAlign",
"type" : "String",
"desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.Menu"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.menu.Menu" : [
+ "Roo.menu.ColorMenu",
+ "Roo.menu.DateMenu"
+ ]
+ },
+ "tree_children" : [
+ "Roo.menu.CheckItem",
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem",
+ "Roo.menu.Item",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem"
+ ],
+ "tree_parent" : []
},
"Roo.menu.MenuMgr" : {
"props" : [],
"returns" : []
},
{
- "name" : "hideAll",
+ "name" : "hideAll",
+ "type" : "function",
+ "desc" : "Hides all menus that are currently visible",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.menu.Separator" : {
+ "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" : "activeClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
+ "memberOf" : "Roo.menu.BaseItem"
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "canActivate",
+ "type" : "Boolean",
+ "desc" : "True if this item can be visually activated (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem"
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
+ "memberOf" : "Roo.menu.BaseItem"
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to prevent creation of this menu item (defaults to false)",
+ "memberOf" : "Roo.menu.BaseItem"
+ },
+ {
+ "name" : "hideDelay",
+ "type" : "Number",
+ "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
+ "memberOf" : "Roo.menu.BaseItem"
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+ "memberOf" : "Roo.Component"
+ },
+ {
+ "name" : "hideOnClick",
+ "type" : "Boolean",
+ "desc" : "True to hide the containing menu after this item is clicked (defaults to false)",
+ "memberOf" : "Roo.menu.Separator"
+ },
+ {
+ "name" : "itemCls",
+ "type" : "String",
+ "desc" : "The default CSS class to use for separators (defaults to \"x-menu-sep\")",
+ "memberOf" : "Roo.menu.Separator"
+ },
+ {
+ "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 item is activated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when this item is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "deactivate",
+ "type" : "function",
+ "desc" : "Fires when this item is deactivated",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.menu.BaseItem",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "un",
"type" : "function",
- "desc" : "Hides all menus that are currently visible",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.menu.Separator" : {
+ "Roo.menu.TextItem" : {
"props" : [
{
"name" : "actionMode",
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.menu.TextItem"
},
{
"name" : "itemCls",
"type" : "String",
- "desc" : "The default CSS class to use for separators (defaults to \"x-menu-sep\")",
- "memberOf" : ""
+ "desc" : "The default CSS class to use for text items (defaults to \"x-menu-text\")",
+ "memberOf" : "Roo.menu.TextItem"
},
{
"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" : "text",
+ "type" : "String",
+ "desc" : "Text to show on item.",
+ "memberOf" : "Roo.menu.TextItem"
}
],
"events" : [
]
},
{
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.state" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.state.CookieProvider" : {
+ "props" : [
+ {
+ "name" : "domain",
+ "type" : "String",
+ "desc" : "The domain to save the cookie for. Note that you cannot specify a different domain than\nyour page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include\nall sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\ndomain the page is running on including the 'www' like 'www.roojs.com')",
+ "memberOf" : "Roo.state.CookieProvider"
+ },
+ {
+ "name" : "expires",
+ "type" : "Date",
+ "desc" : "The cookie expiration date (defaults to 7 days from now)",
+ "memberOf" : "Roo.state.CookieProvider"
+ },
+ {
+ "name" : "path",
+ "type" : "String",
+ "desc" : "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)",
+ "memberOf" : "Roo.state.CookieProvider"
+ },
+ {
+ "name" : "secure",
+ "type" : "Boolean",
+ "desc" : "True if the site is using SSL (defaults to false)",
+ "memberOf" : "Roo.state.CookieProvider"
+ }
+ ],
+ "events" : [
+ {
+ "name" : "statechange",
+ "type" : "function",
+ "desc" : "Fires when a state change occurs.",
+ "sig" : "function (_self, key, value)\n{\n\n}",
+ "memberOf" : "Roo.state.Provider",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Provider",
+ "desc" : "This state provider",
+ "isOptional" : false
+ },
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "The state key which was changed",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The encoded value for the state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "clear",
+ "type" : "function",
+ "desc" : "Clears a value from the state",
+ "sig" : "(name)",
+ "static" : false,
+ "memberOf" : "Roo.state.Provider",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The key name",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "decodeValue",
+ "type" : "function",
+ "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.state.Provider",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value to decode",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "The decoded value"
+ }
+ ]
+ },
+ {
+ "name" : "encodeValue",
+ "type" : "function",
+ "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.state.Provider",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to encode",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The encoded value"
+ }
+ ]
+ },
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "Returns the current value for a key",
+ "sig" : "(name, defaultValue)",
+ "static" : false,
+ "memberOf" : "Roo.state.Provider",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The key name",
+ "isOptional" : false
+ },
+ {
+ "name" : "defaultValue",
+ "type" : "Mixed",
+ "desc" : "A default value to return if the key's value is not found",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "The state data"
+ }
+ ]
+ },
+ {
+ "name" : "set",
+ "type" : "function",
+ "desc" : "Sets the value for a key",
+ "sig" : "(name, value)",
+ "static" : false,
+ "memberOf" : "Roo.state.Provider",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The key name",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.state.Manager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "clear",
+ "type" : "function",
+ "desc" : "Clears a value from the state",
+ "sig" : "(name)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The key name",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "Returns the current value for a key",
+ "sig" : "(name, defaultValue)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The key name",
+ "isOptional" : false
+ },
+ {
+ "name" : "defaultValue",
+ "type" : "Mixed",
+ "desc" : "The default value to return if the key lookup does not match",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "The state data"
+ }
+ ]
+ },
+ {
+ "name" : "getProvider",
+ "type" : "function",
+ "desc" : "Gets the currently configured state provider",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Provider",
+ "desc" : "The state provider"
+ }
+ ]
+ },
+ {
+ "name" : "set",
+ "type" : "function",
+ "desc" : "Sets the value for a key",
+ "sig" : "(name, value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The key name",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The state data",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setProvider",
+ "type" : "function",
+ "desc" : "Configures the default state provider for your application",
+ "sig" : "(stateProvider)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "stateProvider",
+ "type" : "Provider",
+ "desc" : "The state provider to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.state.Provider" : {
+ "props" : [],
+ "events" : [
+ {
+ "name" : "statechange",
+ "type" : "function",
+ "desc" : "Fires when a state change occurs.",
+ "sig" : "function (_self, key, value)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Provider",
+ "desc" : "This state provider",
+ "isOptional" : false
+ },
+ {
+ "name" : "key",
+ "type" : "String",
+ "desc" : "The state key which was changed",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The encoded value for the state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "clear",
+ "type" : "function",
+ "desc" : "Clears a value from the state",
+ "sig" : "(name)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The key name",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "decodeValue",
+ "type" : "function",
+ "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value to decode",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "The decoded value"
+ }
+ ]
+ },
+ {
+ "name" : "encodeValue",
+ "type" : "function",
+ "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to encode",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The encoded value"
+ }
+ ]
+ },
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "Returns the current value for a key",
+ "sig" : "(name, defaultValue)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The key name",
+ "isOptional" : false
+ },
+ {
+ "name" : "defaultValue",
+ "type" : "Mixed",
+ "desc" : "A default value to return if the key's value is not found",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "The state data"
+ }
+ ]
+ },
+ {
+ "name" : "set",
+ "type" : "function",
+ "desc" : "Sets the value for a key",
+ "sig" : "(name, value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The key name",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.state.Provider" : [
+ "Roo.state.CookieProvider"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.tree" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.tree.AsyncTreeNode" : {
+ "props" : [
+ {
+ "name" : "allowDrag",
+ "type" : "Boolean",
+ "desc" : "false to make this node undraggable if DD is on (defaults to true)",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "allowDrop",
+ "type" : "Boolean",
+ "desc" : "false if this node cannot be drop on",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A css class to be added to the node",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "true to start the node disabled",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "expanded",
+ "type" : "Boolean",
+ "desc" : "true to start the node expanded",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "href",
+ "type" : "String",
+ "desc" : "URL of the link used for the node (defaults to #)",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "hrefTarget",
+ "type" : "String",
+ "desc" : "target frame for the link",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "The path to an icon for the node. The preferred way to do this",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "iconCls",
+ "type" : "String",
+ "desc" : "A css class to be added to the nodes icon element for applying css background images",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id for this node. If one is not specified, one is generated.",
+ "memberOf" : "Roo.data.Node"
+ },
+ {
+ "name" : "leaf",
+ "type" : "Boolean",
+ "desc" : "true if this node is a leaf and does not have children",
+ "memberOf" : "Roo.data.Node"
+ },
+ {
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf" : "Roo.util.Observable"
+ },
+ {
+ "name" : "loader",
+ "type" : "TreeLoader",
+ "desc" : "A TreeLoader to be used by this node (defaults to the loader defined on the tree)",
+ "memberOf" : "Roo.tree.AsyncTreeNode"
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "An Ext QuickTip for the node",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "qtipCfg",
+ "type" : "String",
+ "desc" : "An Ext QuickTip config for the node (used instead of qtip)",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "singleClickExpand",
+ "type" : "Boolean",
+ "desc" : "True for single click expand on this node",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text for this node",
+ "memberOf" : "Roo.tree.TreeNode"
+ },
+ {
+ "name" : "uiProvider",
+ "type" : "Function",
+ "desc" : "A UI <b>class</b> to use for this node (defaults to Roo.tree.TreeNodeUI)",
+ "memberOf" : "Roo.tree.TreeNode"
+ }
+ ],
+ "events" : [
{
- "name" : "on",
+ "name" : "append",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a new child node is appended",
+ "sig" : "function (tree, _self, node, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Node",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The newly appended node",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the newly appended node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a new child is appended, return false to cancel the append.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "Roo.data.Node",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be appended",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "beforechildrenrendered",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires right before the child nodes for this node are rendered",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "beforeclick",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before click processing. Return false to cancel the default action.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "beforecollapse",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before this node is collapsed, return false to cancel.",
+ "sig" : "function (_self, deep, anim)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "anim",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "beforeexpand",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before this node is expanded, return false to cancel.",
+ "sig" : "function (_self, deep, anim)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "disabled",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "anim",
"type" : "Boolean",
"desc" : "",
"isOptional" : false
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "beforeinsert",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : "Roo.data.Node",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node is being inserted before",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before this node is loaded, return false to cancel",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "beforemove",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "Roo.data.Node",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent this node is moving to",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it is being moved to",
"isOptional" : false
}
],
"returns" : []
- }
- ]
- },
- "Roo.menu.TextItem" : {
- "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" : "activeClass",
- "type" : "String",
- "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : "Roo.menu.BaseItem"
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "canActivate",
- "type" : "Boolean",
- "desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem"
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
- },
- {
- "name" : "hideDelay",
- "type" : "Number",
- "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "hideOnClick",
- "type" : "Boolean",
- "desc" : "True to hide the containing menu after this item is clicked (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "itemCls",
- "type" : "String",
- "desc" : "The default CSS class to use for text items (defaults to \"x-menu-text\")",
- "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" : "text",
- "type" : "String",
- "desc" : "Text to show on item.",
- "memberOf" : ""
- }
- ],
- "events" : [
- {
- "name" : "activate",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires when this item is activated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Fires before a child is removed, return false to cancel the remove.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "Roo.data.Node",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "checkchange",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a node with a checkbox's checked property changes",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this node is clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "desc" : "Fires when this node is collapsed",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "contextmenu",
"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" : "Fires when this node is right clicked",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "click",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Fires when this item is clicked",
+ "desc" : "Fires when this node is double clicked",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
"name" : "e",
"type" : "Roo.EventObject",
- "desc" : "",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "disabledchange",
"type" : "function",
- "desc" : "Fires when this item is deactivated",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.menu.BaseItem",
+ "desc" : "Fires when the disabled status of this node changes",
+ "sig" : "function (_self, disabled)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.BaseItem",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "expand",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when this node is expanded",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a new child node is inserted.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : "Roo.data.Node",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
+ "desc" : "Fires when this node is loaded",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "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" : "Roo.data.Node",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a child node is removed",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "Roo.data.Node",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The removed node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "textchange",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the text for this node is changed",
+ "sig" : "function (_self, text, oldText)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreeNode",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The new text",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldText",
+ "type" : "String",
+ "desc" : "The old text",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "appendChild",
+ "type" : "function",
+ "desc" : "Insert node(s) as the last child node of this node.",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.data.Node",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node/Array",
+ "desc" : "The node or Array of nodes to append",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The appended node if single append, or null if an array was passed"
+ }
+ ]
+ },
+ {
+ "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" : "Roo.data.Node",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "cascade",
"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}",
+ "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.Component",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Collapse this node.",
+ "sig" : "(deep, anim)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.tree.TreeNode",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to collapse all children as well",
+ "isOptional" : false
+ },
+ {
+ "name" : "anim",
+ "type" : "Boolean",
+ "desc" : "(optional) false to cancel the default animation",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "collapseChildNodes",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Collapse all child nodes",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.tree.TreeNode",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) true if the child nodes should also collapse their child nodes",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "contains",
+ "type" : "function",
+ "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.data.Node",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "fireEvent",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Disables this node",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.tree.TreeNode",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "eachChild",
+ "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)",
+ "static" : false,
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
"isOptional" : false
},
{
"name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enables this node",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.tree.TreeNode",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "ensureVisible",
+ "type" : "function",
+ "desc" : "Ensures all parent nodes are expanded",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.tree.TreeNode",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand this node.",
+ "sig" : "(deep, anim, callback)",
+ "static" : false,
+ "memberOf" : "Roo.tree.TreeNode",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
+ "name" : "deep",
"type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "desc" : "(optional) True to expand all children as well",
+ "isOptional" : false
+ },
+ {
+ "name" : "anim",
+ "type" : "Boolean",
+ "desc" : "(optional) false to cancel the default animation",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) A callback to be called when\nexpanding this node completes (does not wait for deep expand to complete).\nCalled with 1 parameter, this node.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "expandChildNodes",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Expand all child nodes",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.tree.TreeNode",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
+ "name" : "deep",
"type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "desc" : "(optional) true if the child nodes should also expand their child nodes",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "findChild",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Finds the first child that has the attribute with the specified value.",
+ "sig" : "(attribute, value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "attribute",
+ "type" : "String",
+ "desc" : "The attribute name",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to search for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
}
]
},
{
- "name" : "getId",
+ "name" : "findChildBy",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
}
]
},
{
- "name" : "hasListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "hide",
+ "name" : "getDepth",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns depth of this node (the root node has a depth of 0)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "isVisible",
+ "name" : "getOwnerTree",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns the tree this node is in.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Tree",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "getPath",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
+ "sig" : "(attr)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "attr",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The path"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getUI",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns the UI object for this node",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.tree.TreeNode",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "TreeNodeUI",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Returns the index of a child node",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the node or -1 if it was not found"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
+ "sig" : "(node, refNode)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to insert",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The node to insert before (if null the node is appended)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The inserted node"
+ }
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "isAncestor",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "node",
+ "type" : "Node",
"desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "setVisible",
+ "name" : "isExpanded",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Returns true if this node is expanded",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.tree.TreeNode",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "show",
+ "name" : "isFirst",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "Returns true if this node is the first child of its parent",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "un",
+ "name" : "isLast",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Returns true if this node is the last child of its parent",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
- }
- ]
- },
- "Roo.state" : {
- "props" : [],
- "events" : [],
- "methods" : []
- },
- "Roo.state.CookieProvider" : {
- "props" : [
- {
- "name" : "domain",
- "type" : "String",
- "desc" : "The domain to save the cookie for. Note that you cannot specify a different domain than\nyour page is on, but you can specify a sub-domain, or simply the domain itself like 'roojs.com' to include\nall sub-domains if you need to access cookies across different sub-domains (defaults to null which uses the same\ndomain the page is running on including the 'www' like 'www.roojs.com')",
- "memberOf" : ""
- },
- {
- "name" : "expires",
- "type" : "Date",
- "desc" : "The cookie expiration date (defaults to 7 days from now)",
- "memberOf" : ""
- },
- {
- "name" : "path",
- "type" : "String",
- "desc" : "The path for which the cookie is active (defaults to root '/' which makes it active for all pages in the site)",
- "memberOf" : ""
+ ]
},
{
- "name" : "secure",
- "type" : "Boolean",
- "desc" : "True if the site is using SSL (defaults to false)",
- "memberOf" : ""
- }
- ],
- "events" : [
- {
- "name" : "statechange",
+ "name" : "isLeaf",
"type" : "function",
- "desc" : "Fires when a state change occurs.",
- "sig" : "function (_self, key, value)\n{\n\n}",
- "memberOf" : "Roo.state.Provider",
+ "desc" : "Returns true if this node is a leaf",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Node",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Provider",
- "desc" : "This state provider",
- "isOptional" : false
- },
- {
- "name" : "key",
- "type" : "String",
- "desc" : "The state key which was changed",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The encoded value for the state",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
- "name" : "clear",
+ "name" : "isLoaded",
"type" : "function",
- "desc" : "Clears a value from the state",
- "sig" : "(name)",
+ "desc" : "Returns true if this node has been loaded",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.state.Provider",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "The key name",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "decodeValue",
+ "name" : "isLoading",
"type" : "function",
- "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
- "sig" : "(value)",
+ "desc" : "Returns true if this node is currently loading",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.state.Provider",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The value to decode",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "The decoded value"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "encodeValue",
+ "name" : "isSelected",
"type" : "function",
- "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.",
- "sig" : "(value)",
+ "desc" : "Returns true if this node is selected",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.state.Provider",
+ "memberOf" : "Roo.tree.TreeNode",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to encode",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The encoded value"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "get",
+ "name" : "item",
"type" : "function",
- "desc" : "Returns the current value for a key",
- "sig" : "(name, defaultValue)",
+ "desc" : "Returns the child node at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.state.Provider",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "The key name",
- "isOptional" : false
- },
- {
- "name" : "defaultValue",
- "type" : "Mixed",
- "desc" : "A default value to return if the key's value is not found",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "The state data"
+ "type" : "Node",
+ "desc" : ""
}
]
},
{
- "name" : "set",
+ "name" : "on",
"type" : "function",
- "desc" : "Sets the value for a key",
- "sig" : "(name, value)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.state.Provider",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The key name",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
- }
- ]
- },
- "Roo.state.Manager" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "clear",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Clears a value from the state",
- "sig" : "(name)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "The key name",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "get",
+ "name" : "reload",
"type" : "function",
- "desc" : "Returns the current value for a key",
- "sig" : "(name, defaultValue)",
+ "desc" : "Trigger a reload for this node",
+ "sig" : "(callback)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "The key name",
- "isOptional" : false
- },
- {
- "name" : "defaultValue",
- "type" : "Mixed",
- "desc" : "The default value to return if the key lookup does not match",
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "The state data"
- }
- ]
+ "returns" : []
},
{
- "name" : "getProvider",
+ "name" : "removeChild",
"type" : "function",
- "desc" : "Gets the currently configured state provider",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a child node from this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to remove",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Provider",
- "desc" : "The state provider"
+ "type" : "Node",
+ "desc" : "The removed node"
}
]
},
{
- "name" : "set",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Sets the value for a key",
- "sig" : "(name, value)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The key name",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The state data",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setProvider",
+ "name" : "replaceChild",
"type" : "function",
- "desc" : "Configures the default state provider for your application",
- "sig" : "(stateProvider)",
+ "desc" : "Replaces one child node in this node with another.",
+ "sig" : "(newChild, oldChild)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "stateProvider",
- "type" : "Provider",
- "desc" : "The state provider to set",
+ "name" : "newChild",
+ "type" : "Node",
+ "desc" : "The replacement node",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldChild",
+ "type" : "Node",
+ "desc" : "The node to replace",
"isOptional" : false
}
],
- "returns" : []
- }
- ]
- },
- "Roo.state.Provider" : {
- "props" : [],
- "events" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The replaced node"
+ }
+ ]
+ },
{
- "name" : "statechange",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires when a state change occurs.",
- "sig" : "function (_self, key, value)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Triggers selection of this node",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.tree.TreeNode",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Provider",
- "desc" : "This state provider",
- "isOptional" : false
- },
- {
- "name" : "key",
- "type" : "String",
- "desc" : "The state key which was changed",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The encoded value for the state",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "clear",
+ "name" : "setText",
"type" : "function",
- "desc" : "Clears a value from the state",
- "sig" : "(name)",
+ "desc" : "Sets the text for this node",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.tree.TreeNode",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
+ "name" : "text",
"type" : "String",
- "desc" : "The key name",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "decodeValue",
+ "name" : "sort",
"type" : "function",
- "desc" : "Decodes a string previously encoded with {@link #encodeValue}.",
- "sig" : "(value)",
+ "desc" : "Sorts this nodes children using the supplied sort function",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Node",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The value to decode",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "The decoded value"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "encodeValue",
+ "name" : "toggle",
"type" : "function",
- "desc" : "Encodes a value including type information. Decode with {@link #decodeValue}.",
- "sig" : "(value)",
+ "desc" : "Toggles expanded/collapsed state of the node",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.tree.TreeNode",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to encode",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The encoded value"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "get",
+ "name" : "un",
"type" : "function",
- "desc" : "Returns the current value for a key",
- "sig" : "(name, defaultValue)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "name",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The key name",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "defaultValue",
- "type" : "Mixed",
- "desc" : "A default value to return if the key's value is not found",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "The state data"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "set",
+ "name" : "unselect",
"type" : "function",
- "desc" : "Sets the value for a key",
- "sig" : "(name, value)",
+ "desc" : "Triggers deselection of this node",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.tree.TreeNode",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The key name",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
}
- ]
- },
- "Roo.tree" : {
- "props" : [],
- "events" : [],
- "methods" : []
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.tree.AsyncTreeNode" : {
+ "Roo.tree.ColumnTree" : {
"props" : [
{
- "name" : "allowDrag",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "false to make this node undraggable if DD is on (defaults to true)",
- "memberOf" : "Roo.tree.TreeNode"
+ "desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "allowDrop",
- "type" : "Boolean",
- "desc" : "false if this node cannot be drop on",
- "memberOf" : "Roo.tree.TreeNode"
+ "name" : "borderWidth",
+ "type" : "int",
+ "desc" : "compined right/left border allowance",
+ "memberOf" : "Roo.tree.ColumnTree"
},
{
- "name" : "checked",
+ "name" : "columns",
+ "type" : "Object",
+ "desc" : "Including width, header, renderer, cls, dataIndex",
+ "memberOf" : "Roo.tree.ColumnTree"
+ },
+ {
+ "name" : "containerScroll",
"type" : "Boolean",
- "desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)",
- "memberOf" : "Roo.tree.TreeNode"
+ "desc" : "true to register this container with ScrollManager",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "cls",
+ "name" : "ddAppendOnly",
"type" : "String",
- "desc" : "A css class to be added to the node",
- "memberOf" : "Roo.tree.TreeNode"
+ "desc" : "True if the tree should only allow append drops (use for trees which are sorted)",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "true to start the node disabled",
- "memberOf" : "Roo.tree.TreeNode"
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "The DD group this TreePanel belongs to",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "expanded",
+ "name" : "ddScroll",
"type" : "Boolean",
- "desc" : "true to start the node expanded",
- "memberOf" : "Roo.tree.TreeNode"
+ "desc" : "true to enable YUI body scrolling",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "href",
- "type" : "String",
- "desc" : "URL of the link used for the node (defaults to #)",
- "memberOf" : "Roo.tree.TreeNode"
+ "name" : "dragConfig",
+ "type" : "Object",
+ "desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "hrefTarget",
- "type" : "String",
- "desc" : "target frame for the link",
- "memberOf" : "Roo.tree.TreeNode"
+ "name" : "dropConfig",
+ "type" : "Object",
+ "desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "The path to an icon for the node. The preferred way to do this",
- "memberOf" : "Roo.tree.TreeNode"
+ "name" : "editor",
+ "type" : "Roo.tree.TreeEditor",
+ "desc" : "The TreeEditor to display when clicked.",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "iconCls",
- "type" : "String",
- "desc" : "A css class to be added to the nodes icon element for applying css background images",
- "memberOf" : "Roo.tree.TreeNode"
+ "name" : "enableDD",
+ "type" : "Boolean",
+ "desc" : "true to enable drag and drop",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "id",
+ "name" : "enableDrag",
+ "type" : "Boolean",
+ "desc" : "true to enable just drag",
+ "memberOf" : "Roo.tree.TreePanel"
+ },
+ {
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "true to enable just drop",
+ "memberOf" : "Roo.tree.TreePanel"
+ },
+ {
+ "name" : "hlColor",
"type" : "String",
- "desc" : "The id for this node. If one is not specified, one is generated.",
- "memberOf" : "Roo.data.Node"
+ "desc" : "The color of the node highlight (defaults to C3DAF9)",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "leaf",
+ "name" : "hlDrop",
"type" : "Boolean",
- "desc" : "true if this node is a leaf and does not have children",
- "memberOf" : "Roo.data.Node"
+ "desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)",
+ "memberOf" : "Roo.tree.TreePanel"
+ },
+ {
+ "name" : "lines",
+ "type" : "Boolean",
+ "desc" : "false to disable tree lines (defaults to true)",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "listeners",
},
{
"name" : "loader",
- "type" : "TreeLoader",
- "desc" : "A TreeLoader to be used by this node (defaults to the loader defined on the tree)",
- "memberOf" : ""
+ "type" : "Roo.tree.TreeLoader",
+ "desc" : "A TreeLoader for use with this TreePanel",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "qtip",
+ "name" : "pathSeparator",
"type" : "String",
- "desc" : "An Ext QuickTip for the node",
- "memberOf" : "Roo.tree.TreeNode"
+ "desc" : "The token used to separate sub-paths in path strings (defaults to '/')",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "qtipCfg",
- "type" : "String",
- "desc" : "An Ext QuickTip config for the node (used instead of qtip)",
- "memberOf" : "Roo.tree.TreeNode"
+ "name" : "renderer",
+ "type" : "Function",
+ "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "singleClickExpand",
+ "name" : "rendererTip",
+ "type" : "Function",
+ "desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
+ "memberOf" : "Roo.tree.TreePanel"
+ },
+ {
+ "name" : "root",
+ "type" : "Roo.tree.TreeNode",
+ "desc" : "The root node",
+ "memberOf" : "Roo.tree.TreePanel"
+ },
+ {
+ "name" : "rootVisible",
"type" : "Boolean",
- "desc" : "True for single click expand on this node",
- "memberOf" : "Roo.tree.TreeNode"
+ "desc" : "false to hide the root node (defaults to true)",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "text",
- "type" : "String",
- "desc" : "The text for this node",
- "memberOf" : "Roo.tree.TreeNode"
+ "name" : "selModel",
+ "type" : "Boolean",
+ "desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})",
+ "memberOf" : "Roo.tree.TreePanel"
},
{
- "name" : "uiProvider",
- "type" : "Function",
- "desc" : "A UI <b>class</b> to use for this node (defaults to Roo.tree.TreeNodeUI)",
- "memberOf" : "Roo.tree.TreeNode"
+ "name" : "singleExpand",
+ "type" : "Boolean",
+ "desc" : "true if only 1 node per branch may be expanded",
+ "memberOf" : "Roo.tree.TreePanel"
}
],
"events" : [
{
"name" : "append",
"type" : "function",
- "desc" : "Fires when a new child node is appended",
- "sig" : "function (tree, _self, node, index)\n{\n\n}",
- "memberOf" : "Roo.data.Node",
+ "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" : "Roo.data.Tree",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "this",
+ "name" : "parent",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
],
"returns" : []
},
+ {
+ "name" : "appendnode",
+ "type" : "function",
+ "desc" : "Fires when append node to the tree",
+ "sig" : "function (_self, node, index)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.tree.TreePanel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Roo.tree.TreeNode",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the newly appended node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforeappend",
"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" : "Roo.data.Node",
+ "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" : "Roo.data.Tree",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "this",
+ "name" : "parent",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
{
"name" : "beforechildrenrendered",
"type" : "function",
- "desc" : "Fires right before the child nodes for this node are rendered",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires right before the child nodes for a node are rendered",
+ "sig" : "function (node)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
}
],
{
"name" : "beforeclick",
"type" : "function",
- "desc" : "Fires before click processing. Return false to cancel the default action.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires before click processing on a node. Return false to cancel the default action.",
+ "sig" : "function (node, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
},
{
{
"name" : "beforecollapse",
"type" : "function",
- "desc" : "Fires before this node is collapsed, return false to cancel.",
- "sig" : "function (_self, deep, anim)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires before a node is collapsed, return false to cancel.",
+ "sig" : "function (node, deep, anim)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
},
{
{
"name" : "beforeexpand",
"type" : "function",
- "desc" : "Fires before this node is expanded, return false to cancel.",
- "sig" : "function (_self, deep, anim)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires before a node is expanded, return false to cancel.",
+ "sig" : "function (node, deep, anim)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
},
{
{
"name" : "beforeinsert",
"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" : "Roo.data.Node",
+ "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" : "Roo.data.Tree",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "this",
+ "name" : "parent",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
{
"name" : "beforeload",
"type" : "function",
- "desc" : "Fires before this node is loaded, return false to cancel",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before a node is loaded, return false to cancel",
+ "sig" : "function (node)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node being loaded",
"isOptional" : false
}
],
{
"name" : "beforemove",
"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" : "Roo.data.Node",
+ "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" : "Roo.data.Tree",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node being moved",
"isOptional" : false
},
{
"name" : "oldParent",
"type" : "Node",
- "desc" : "The parent of this node",
+ "desc" : "The parent of the node",
"isOptional" : false
},
{
"name" : "newParent",
"type" : "Node",
- "desc" : "The new parent this node is moving to",
+ "desc" : "The new parent the node is moving to",
"isOptional" : false
},
{
],
"returns" : []
},
+ {
+ "name" : "beforenodedrop",
+ "type" : "function",
+ "desc" : "Fires when a DD object is dropped on a node in this tree for preprocessing. Return false to cancel the drop. The dropEvent\npassed to handlers has the following properties:<br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>tree - The TreePanel</li>\n<li>target - The node being targeted for the drop</li>\n<li>data - The drag data from the drag source</li>\n<li>point - The point of the drop - append, above or below</li>\n<li>source - The drag source</li>\n<li>rawEvent - Raw mouse event</li>\n<li>dropNode - Drop node(s) provided by the source <b>OR</b> you can supply node(s)\nto be inserted by setting them on this object.</li>\n<li>cancel - Set this to true to cancel the drop.</li>\n</ul>",
+ "sig" : "function (dropEvent)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "dropEvent",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforeremove",
"type" : "function",
- "desc" : "Fires before a child is removed, return false to cancel the remove.",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "Roo.data.Node",
+ "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" : "Roo.data.Tree",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "this",
+ "name" : "parent",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
"type" : "function",
"desc" : "Fires when a node with a checkbox's checked property changes",
"sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
{
"name" : "click",
"type" : "function",
- "desc" : "Fires when this node is clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires when a node is clicked",
+ "sig" : "function (node, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
},
{
{
"name" : "collapse",
"type" : "function",
- "desc" : "Fires when this node is collapsed",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires when a node is collapsed",
+ "sig" : "function (node)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
}
],
{
"name" : "contextmenu",
"type" : "function",
- "desc" : "Fires when this node is right clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires when a node is right clicked",
+ "sig" : "function (node, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
},
{
{
"name" : "dblclick",
"type" : "function",
- "desc" : "Fires when this node is double clicked",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires when a node is double clicked",
+ "sig" : "function (node, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
},
{
{
"name" : "disabledchange",
"type" : "function",
- "desc" : "Fires when the disabled status of this node changes",
- "sig" : "function (_self, disabled)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires when the disabled status of a node changes",
+ "sig" : "function (node, disabled)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
},
{
"returns" : []
},
{
- "name" : "expand",
+ "name" : "dragdrop",
"type" : "function",
- "desc" : "Fires when this node is expanded",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "desc" : "Fires when a dragged node is dropped on a valid DD target",
+ "sig" : "function (_self, node, dd, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Roo.tree.TreePanel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Roo.tree.TreeNode",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "DD",
+ "desc" : "The dd it was dropped on",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "enddrag",
"type" : "function",
- "desc" : "Fires when a new child node is inserted.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : "Roo.data.Node",
+ "desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, node, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Roo.tree.TreePanel",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "node",
- "type" : "Node",
- "desc" : "The child node inserted",
+ "type" : "Roo.tree.TreeNode",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node was inserted before",
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "expand",
"type" : "function",
- "desc" : "Fires when this node is loaded",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a node is expanded",
+ "sig" : "function (node)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "insert",
"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" : "Roo.data.Node",
+ "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" : "Roo.data.Tree",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "this",
+ "name" : "parent",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
- "name" : "oldParent",
+ "name" : "node",
"type" : "Node",
- "desc" : "The old parent of this node",
+ "desc" : "The child node inserted",
"isOptional" : false
},
{
- "name" : "newParent",
+ "name" : "refNode",
"type" : "Node",
- "desc" : "The new parent of this node",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it was moved to",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires when a child node is removed",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "Roo.data.Node",
+ "desc" : "Fires when a node is loaded",
+ "sig" : "function (node)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
{
"name" : "node",
"type" : "Node",
- "desc" : "The removed node",
+ "desc" : "The node that was loaded",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "textchange",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires when the text for this node is changed",
- "sig" : "function (_self, text, oldText)\n{\n\n}",
- "memberOf" : "Roo.tree.TreeNode",
+ "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" : "Roo.data.Tree",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
"type" : "Node",
- "desc" : "This node",
+ "desc" : "The node moved",
"isOptional" : false
},
{
- "name" : "text",
- "type" : "String",
- "desc" : "The new text",
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
"isOptional" : false
},
{
- "name" : "oldText",
- "type" : "String",
- "desc" : "The old text",
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
"isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "nodedragover",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a tree node is being targeted for a drag drop, return false to signal drop not allowed. The dragOverEvent\npassed to handlers has the following properties:<br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>tree - The TreePanel</li>\n<li>target - The node being targeted for the drop</li>\n<li>data - The drag data from the drag source</li>\n<li>point - The point of the drop - append, above or below</li>\n<li>source - The drag source</li>\n<li>rawEvent - Raw mouse event</li>\n<li>dropNode - Drop node(s) provided by the source.</li>\n<li>cancel - Set this to true to signal drop not allowed.</li>\n</ul>",
+ "sig" : "function (dragOverEvent)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
+ "name" : "dragOverEvent",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "appendChild",
+ "name" : "nodedrop",
"type" : "function",
- "desc" : "Insert node(s) as the last child node of this node.",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after a DD object is dropped on a node in this tree. The dropEvent\npassed to handlers has the following properties:<br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>tree - The TreePanel</li>\n<li>target - The node being targeted for the drop</li>\n<li>data - The drag data from the drag source</li>\n<li>point - The point of the drop - append, above or below</li>\n<li>source - The drag source</li>\n<li>rawEvent - Raw mouse event</li>\n<li>dropNode - Dropped node(s).</li>\n</ul>",
+ "sig" : "function (dropEvent)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node/Array",
- "desc" : "The node or Array of nodes to append",
+ "name" : "dropEvent",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The appended node if single append, or null if an array was passed"
- }
- ]
+ "returns" : []
},
{
- "name" : "bubble",
+ "name" : "remove",
"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" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a child node is removed from a node in this tree.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
+ "memberOf" : "Roo.data.Tree",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "resize",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire this event on a container when it resizes",
+ "sig" : "function (w, h)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "w",
+ "type" : "int",
+ "desc" : "Width",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "h",
+ "type" : "int",
+ "desc" : "Height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cascade",
+ "name" : "startdrag",
"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)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a node starts being dragged",
+ "sig" : "function (_self, node, e)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "this",
+ "type" : "Roo.tree.TreePanel",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
+ "name" : "node",
+ "type" : "Roo.tree.TreeNode",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "textchange",
"type" : "function",
- "desc" : "Collapse this node.",
- "sig" : "(deep, anim)",
- "static" : false,
- "memberOf" : "Roo.tree.TreeNode",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the text for a node is changed",
+ "sig" : "function (node, text, oldText)\n{\n\n}",
+ "memberOf" : "Roo.tree.TreePanel",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) True to collapse all children as well",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node",
"isOptional" : false
},
{
- "name" : "anim",
- "type" : "Boolean",
- "desc" : "(optional) false to cancel the default animation",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The new text",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldText",
+ "type" : "String",
+ "desc" : "The old text",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "collapseChildNodes",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Collapse all child nodes",
- "sig" : "(deep)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.tree.TreeNode",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) true if the child nodes should also collapse their child nodes",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "contains",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
- "sig" : "(node)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.data.Node",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disables this node",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.tree.TreeNode",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "eachChild",
+ "name" : "capture",
"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)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
{
"name" : "fn",
"type" : "Function",
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "collapseAll",
"type" : "function",
- "desc" : "Enables this node",
+ "desc" : "Collapse all nodes",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.tree.TreeNode",
+ "memberOf" : "Roo.tree.TreePanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "ensureVisible",
+ "name" : "expandAll",
"type" : "function",
- "desc" : "Ensures all parent nodes are expanded",
+ "desc" : "Expand all nodes",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.tree.TreeNode",
+ "memberOf" : "Roo.tree.TreePanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "expand",
+ "name" : "expandPath",
"type" : "function",
- "desc" : "Expand this node.",
- "sig" : "(deep, anim, callback)",
+ "desc" : "Expands a specified path in this TreePanel. A path can be retrieved from a node with {@link Roo.data.Node#getPath}",
+ "sig" : "(path, attr, callback)",
"static" : false,
- "memberOf" : "Roo.tree.TreeNode",
+ "memberOf" : "Roo.tree.TreePanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) True to expand all children as well",
+ "name" : "path",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "anim",
- "type" : "Boolean",
- "desc" : "(optional) false to cancel the default animation",
+ "name" : "attr",
+ "type" : "String",
+ "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)",
"isOptional" : false
},
{
"name" : "callback",
"type" : "Function",
- "desc" : "(optional) A callback to be called when\nexpanding this node completes (does not wait for deep expand to complete).\nCalled with 1 parameter, this node.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "expandChildNodes",
- "type" : "function",
- "desc" : "Expand all child nodes",
- "sig" : "(deep)",
- "static" : false,
- "memberOf" : "Roo.tree.TreeNode",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) true if the child nodes should also expand their child nodes",
+ "desc" : "(optional) The callback to call when the expand is complete. The callback will be called with\n(bSuccess, oLastNode) where bSuccess is if the expand was successful and oLastNode is the last node that was expanded.",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "findChild",
- "type" : "function",
- "desc" : "Finds the first child that has the attribute with the specified value.",
- "sig" : "(attribute, value)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "attribute",
- "type" : "String",
- "desc" : "The attribute name",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to search for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
- }
- ]
- },
- {
- "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" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getDepth",
- "type" : "function",
- "desc" : "Returns depth of this node (the root node has a depth of 0)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getOwnerTree",
- "type" : "function",
- "desc" : "Returns the tree this node is in.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Tree",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getPath",
- "type" : "function",
- "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
- "sig" : "(attr)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "attr",
- "type" : "String",
- "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The path"
- }
- ]
- },
- {
- "name" : "getUI",
- "type" : "function",
- "desc" : "Returns the UI object for this node",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.tree.TreeNode",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "TreeNodeUI",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "hasListener",
+ "name" : "getChecked",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Retrieve an array of checked nodes, or an array of a specific attribute of checked nodes (e.g. \"id\")",
+ "sig" : "(attribute, startNode)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.tree.TreePanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "attribute",
"type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "indexOf",
- "type" : "function",
- "desc" : "Returns the index of a child node",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the node or -1 if it was not found"
- }
- ]
- },
- {
- "name" : "insertBefore",
- "type" : "function",
- "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
- "sig" : "(node, refNode)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to insert",
+ "desc" : "(optional) Defaults to null (return the actual nodes)",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The node to insert before (if null the node is appended)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The inserted node"
- }
- ]
- },
- {
- "name" : "isAncestor",
- "type" : "function",
- "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "startNode",
+ "type" : "TreeNode",
+ "desc" : "(optional) The node to start from, defaults to the root",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if this node is expanded",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.tree.TreeNode",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
+ "type" : "Array",
"desc" : ""
}
]
},
{
- "name" : "isFirst",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns true if this node is the first child of its parent",
+ "desc" : "Returns the container element for this TreePanel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Node",
+ "memberOf" : "Roo.tree.TreePanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isLast",
+ "name" : "getLoader",
"type" : "function",
- "desc" : "Returns true if this node is the last child of its parent",
+ "desc" : "Returns the default TreeLoader for this TreePanel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Node",
+ "memberOf" : "Roo.tree.TreePanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "isLeaf",
+ "name" : "getNodeById",
"type" : "function",
- "desc" : "Returns true if this node is a leaf",
- "sig" : "()\n{\n\n}",
+ "desc" : "Gets a node in this tree by its id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Node",
+ "memberOf" : "Roo.data.Tree",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "id",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "isLoaded",
- "type" : "function",
- "desc" : "Returns true if this node has been loaded",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
+ "type" : "Node",
"desc" : ""
}
]
},
{
- "name" : "isLoading",
+ "name" : "getRootNode",
"type" : "function",
- "desc" : "Returns true if this node is currently loading",
+ "desc" : "Returns the root node for this tree.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Tree",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
+ "type" : "Node",
"desc" : ""
}
]
},
{
- "name" : "isSelected",
+ "name" : "getSelectionModel",
"type" : "function",
- "desc" : "Returns true if this node is selected",
+ "desc" : "Returns the selection model used by this TreePanel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.tree.TreeNode",
+ "memberOf" : "Roo.tree.TreePanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "item",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns the child node at the specified index.",
- "sig" : "(index)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.data.Node",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
],
"returns" : []
},
- {
- "name" : "reload",
- "type" : "function",
- "desc" : "Trigger a reload for this node",
- "sig" : "(callback)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeChild",
- "type" : "function",
- "desc" : "Removes a child node from this node.",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to remove",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The removed node"
- }
- ]
- },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "replaceChild",
- "type" : "function",
- "desc" : "Replaces one child node in this node with another.",
- "sig" : "(newChild, oldChild)",
- "static" : false,
- "memberOf" : "Roo.data.Node",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "newChild",
- "type" : "Node",
- "desc" : "The replacement node",
- "isOptional" : false
- },
- {
- "name" : "oldChild",
- "type" : "Node",
- "desc" : "The node to replace",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The replaced node"
- }
- ]
- },
- {
- "name" : "select",
+ "name" : "render",
"type" : "function",
- "desc" : "Triggers selection of this node",
+ "desc" : "Trigger rendering of this TreePanel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.tree.TreeNode",
+ "memberOf" : "Roo.tree.TreePanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setText",
+ "name" : "selectPath",
"type" : "function",
- "desc" : "Sets the text for this node",
- "sig" : "(text)",
+ "desc" : "Selects the node in this tree at the specified path. A path can be retrieved from a node with {@link Roo.data.Node#getPath}",
+ "sig" : "(path, attr, callback)",
"static" : false,
- "memberOf" : "Roo.tree.TreeNode",
+ "memberOf" : "Roo.tree.TreePanel",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "text",
+ "name" : "path",
"type" : "String",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "attr",
+ "type" : "String",
+ "desc" : "(optional) The attribute used in the path (see {@link Roo.data.Node#getPath} for more info)",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) The callback to call when the selection is complete. The callback will be called with\n(bSuccess, oSelNode) where bSuccess is if the selection was successful and oSelNode is the selected node.",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "sort",
+ "name" : "setRootNode",
"type" : "function",
- "desc" : "Sorts this nodes children using the supplied sort function",
- "sig" : "(fn, scope)",
+ "desc" : "Sets the root node for this tree.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Node",
+ "memberOf" : "Roo.data.Tree",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
+ "name" : "node",
+ "type" : "Node",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "toggle",
- "type" : "function",
- "desc" : "Toggles expanded/collapsed state of the node",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.tree.TreeNode",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "un",
}
],
"returns" : []
- },
- {
- "name" : "unselect",
- "type" : "function",
- "desc" : "Triggers deselection of this node",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.tree.TreeNode",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ]
- },
- "Roo.tree.ColumnTree" : {
- "props" : [
- {
- "name" : "borderWidth",
- "type" : "int",
- "desc" : "compined right/left border allowance",
- "memberOf" : ""
- },
- {
- "name" : "columns",
- "type" : "Object",
- "desc" : "Including width, header, renderer, cls, dataIndex",
- "memberOf" : ""
}
],
- "events" : [
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fire this event on a container when it resizes",
- "sig" : "function (w, h)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "w",
- "type" : "int",
- "desc" : "Width",
- "isOptional" : false
- },
- {
- "name" : "h",
- "type" : "int",
- "desc" : "Height",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : []
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.tree.DefaultSelectionModel" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.tree.MultiSelectionModel" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.tree.TreeEditor" : {
"props" : [
"name" : "alignment",
"type" : "String",
"desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"l-l\").",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeEditor"
},
{
"name" : "allowDomMove",
"name" : "cls",
"type" : "String",
"desc" : "CSS class to apply to the editor (defaults to \"x-small-editor x-tree-editor\")",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeEditor"
},
{
"name" : "completeOnEnter",
"name" : "field",
"type" : "Roo.form.TextField",
"desc" : "[required] The field configuration",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeEditor"
},
{
"name" : "hideEl",
"type" : "Boolean",
"desc" : "True to hide the bound element while the editor is displayed (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeEditor"
},
{
"name" : "hideMode",
"name" : "maxWidth",
"type" : "Number",
"desc" : "The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed\nthe containing tree element's size, it will be automatically limited for you to the container width, taking\nscroll and client offsets into account prior to each edit.",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeEditor"
},
{
"name" : "revertInvalid",
"name" : "shim",
"type" : "Boolean",
"desc" : "True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeEditor"
},
{
"name" : "tree",
"type" : "Roo.tree.TreePanel",
"desc" : "The tree to bind to.",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeEditor"
},
{
"name" : "updateEl",
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.tree.TreeFilter" : {
"props" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.tree.TreeLoader" : {
"props" : [
"name" : "baseAttrs",
"type" : "Object",
"desc" : "(optional) An object containing attributes to be added to all nodes\ncreated by this loader. If the attributes sent by the server have an attribute in this object,\nthey take priority.",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeLoader"
},
{
"name" : "baseParams",
"type" : "Object",
"desc" : "(optional) An object containing properties which\nspecify HTTP parameters to be passed to each request for child nodes.",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeLoader"
},
{
"name" : "clearOnLoad",
"type" : "Boolean",
"desc" : "(optional) Default to true. Remove previously existing\nchild nodes before loading.",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeLoader"
},
{
"name" : "dataUrl",
"type" : "String",
"desc" : "The URL from which to request a Json string which\nspecifies an array of node definition object representing the child nodes\nto be loaded.",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeLoader"
},
{
"name" : "listeners",
"name" : "queryParam",
"type" : "String",
"desc" : "(optional) \nName of the query as it will be passed on the querystring (defaults to 'node')\neg. the request will be ?node=[id]",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeLoader"
},
{
"name" : "requestMethod",
"type" : "String",
"desc" : "either GET or POST\ndefaults to POST (due to BC)\nto be loaded.",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeLoader"
},
{
"name" : "root",
"type" : "String",
"desc" : "(optional) Default to false. Use this to read data from an object \nproperty on loading, rather than expecting an array. (eg. more compatible to a standard\nGrid query { data : [ .....] }",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeLoader"
},
{
"name" : "uiProviders",
"type" : "Object",
"desc" : "(optional) An object containing properties which\n\nDEPRECATED - use 'create' event handler to modify attributes - which affect creation.\nspecify custom {@link Roo.tree.TreeNodeUI} implementations. If the optional\n<i>uiProvider</i> attribute of a returned child node is a string rather\nthan a reference to a TreeNodeUI implementation, this that string value\nis used as a property name in the uiProviders object. You can define the provider named\n'default' , and this will be used for all nodes (if no uiProvider is delivered by the node data)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeLoader"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.tree.TreeNode" : {
"props" : [
"name" : "allowDrag",
"type" : "Boolean",
"desc" : "false to make this node undraggable if DD is on (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "allowDrop",
"type" : "Boolean",
"desc" : "false if this node cannot be drop on",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "checked",
"type" : "Boolean",
"desc" : "True to render a checked checkbox for this node, false to render an unchecked checkbox\n(defaults to undefined with no checkbox rendered)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "cls",
"type" : "String",
"desc" : "A css class to be added to the node",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "true to start the node disabled",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "expanded",
"type" : "Boolean",
"desc" : "true to start the node expanded",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "href",
"type" : "String",
"desc" : "URL of the link used for the node (defaults to #)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "hrefTarget",
"type" : "String",
"desc" : "target frame for the link",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "icon",
"type" : "String",
"desc" : "The path to an icon for the node. The preferred way to do this",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "iconCls",
"type" : "String",
"desc" : "A css class to be added to the nodes icon element for applying css background images",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "id",
"name" : "qtip",
"type" : "String",
"desc" : "An Ext QuickTip for the node",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "qtipCfg",
"type" : "String",
"desc" : "An Ext QuickTip config for the node (used instead of qtip)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "singleClickExpand",
"type" : "Boolean",
"desc" : "True for single click expand on this node",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "text",
"type" : "String",
"desc" : "The text for this node",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
},
{
"name" : "uiProvider",
"type" : "Function",
"desc" : "A UI <b>class</b> to use for this node (defaults to Roo.tree.TreeNodeUI)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeNode"
}
],
"events" : [
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.tree.TreeNode" : [
+ "Roo.tree.AsyncTreeNode"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.tree.TreeNodeUI" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.tree.TreePanel" : {
"props" : [
"name" : "animate",
"type" : "Boolean",
"desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "containerScroll",
"type" : "Boolean",
"desc" : "true to register this container with ScrollManager",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "ddAppendOnly",
"type" : "String",
"desc" : "True if the tree should only allow append drops (use for trees which are sorted)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "The DD group this TreePanel belongs to",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "ddScroll",
"type" : "Boolean",
"desc" : "true to enable YUI body scrolling",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "dragConfig",
"type" : "Object",
"desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "dropConfig",
"type" : "Object",
"desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "editor",
"type" : "Roo.tree.TreeEditor",
"desc" : "The TreeEditor to display when clicked.",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "enableDD",
"type" : "Boolean",
"desc" : "true to enable drag and drop",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "enableDrag",
"type" : "Boolean",
"desc" : "true to enable just drag",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "enableDrop",
"type" : "Boolean",
"desc" : "true to enable just drop",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "hlColor",
"type" : "String",
"desc" : "The color of the node highlight (defaults to C3DAF9)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "hlDrop",
"type" : "Boolean",
"desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "lines",
"type" : "Boolean",
"desc" : "false to disable tree lines (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "listeners",
"name" : "loader",
"type" : "Roo.tree.TreeLoader",
"desc" : "A TreeLoader for use with this TreePanel",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "pathSeparator",
"type" : "String",
"desc" : "The token used to separate sub-paths in path strings (defaults to '/')",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "renderer",
"type" : "Function",
"desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "rendererTip",
"type" : "Function",
"desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "root",
"type" : "Roo.tree.TreeNode",
"desc" : "The root node",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "rootVisible",
"type" : "Boolean",
"desc" : "false to hide the root node (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "selModel",
"type" : "Boolean",
"desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
},
{
"name" : "singleExpand",
"type" : "Boolean",
"desc" : "true if only 1 node per branch may be expanded",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreePanel"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.tree.TreePanel" : [
+ "Roo.tree.ColumnTree"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.tree.TreeSorter" : {
"props" : [
"name" : "caseSensitive",
"type" : "Boolean",
"desc" : "true for case sensitive sort (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeSorter"
},
{
"name" : "dir",
"type" : "String",
"desc" : "The direction to sort (asc or desc) (defaults to asc)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeSorter"
},
{
"name" : "folderSort",
"type" : "Boolean",
"desc" : "True to sort leaf nodes under non leaf nodes",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeSorter"
},
{
"name" : "leafAttr",
"type" : "String",
"desc" : "The attribute used to determine leaf nodes in folder sort (defaults to \"leaf\")",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeSorter"
},
{
"name" : "property",
"type" : "String",
"desc" : "The named attribute on the node to sort by (defaults to text)",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeSorter"
},
{
"name" : "sortType",
"type" : "Function",
"desc" : "A custom \"casting\" function used to convert node values before sorting",
- "memberOf" : ""
+ "memberOf" : "Roo.tree.TreeSorter"
}
],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.CSS" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.ClickRepeater" : {
"props" : [
"name" : "accelerate",
"type" : "Boolean",
"desc" : "True if autorepeating should start slowly and accelerate.\n \"interval\" and \"delay\" are ignored. \"immediate\" is honored.",
- "memberOf" : ""
+ "memberOf" : "Roo.util.ClickRepeater"
},
{
"name" : "delay",
"type" : "Number",
"desc" : "The initial delay before the repeating event begins firing.\nSimilar to an autorepeat key delay.",
- "memberOf" : ""
+ "memberOf" : "Roo.util.ClickRepeater"
},
{
"name" : "el",
"type" : "String/HTMLElement/Element",
"desc" : "The element to act as a button.",
- "memberOf" : ""
+ "memberOf" : "Roo.util.ClickRepeater"
},
{
"name" : "interval",
"type" : "Number",
"desc" : "The interval between firings of the \"click\" event. Default 10 ms.",
- "memberOf" : ""
+ "memberOf" : "Roo.util.ClickRepeater"
},
{
"name" : "listeners",
"name" : "pressClass",
"type" : "String",
"desc" : "A CSS class name to be applied to the element while pressed.",
- "memberOf" : ""
+ "memberOf" : "Roo.util.ClickRepeater"
},
{
"name" : "preventDefault",
"type" : "Boolean",
"desc" : "True to prevent the default click event",
- "memberOf" : ""
+ "memberOf" : "Roo.util.ClickRepeater"
},
{
"name" : "stopDefault",
"type" : "Boolean",
"desc" : "True to stop the default click event",
- "memberOf" : ""
+ "memberOf" : "Roo.util.ClickRepeater"
}
],
"events" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.Clipboard" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.DelayedTask" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.Format" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.JSON" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.MixedCollection" : {
"props" : [
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.Observable" : {
"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" : ""
+ "memberOf" : "Roo.util.Observable"
}
],
"events" : [],
],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : {
+ "Roo.bootstrap.nav.Item" : [
+ "Roo.bootstrap.nav.SidebarItem"
+ ],
+ "Roo.ContentPanel" : [
+ "Roo.GridPanel",
+ "Roo.NestedLayoutPanel",
+ "Roo.TreePanel"
+ ],
+ "Roo.LayoutRegion" : [
+ "Roo.SplitLayoutRegion",
+ "Roo.bootstrap.layout.Split"
+ ],
+ "Roo.form.Layout" : [
+ "Roo.form.Column",
+ "Roo.form.FieldSet",
+ "Roo.form.Row"
+ ],
+ "Roo.bootstrap.Column" : [
+ "Roo.bootstrap.TabGroup"
+ ],
+ "Roo.grid.EditorGrid" : [
+ "Roo.grid.PropertyGrid"
+ ],
+ "Roo.LayoutManager" : [
+ "Roo.BorderLayout"
+ ],
+ "Roo.dd.DropTarget" : [
+ "Roo.dd.DropZone"
+ ],
+ "Roo.bootstrap.Element" : [
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.DropTarget"
+ ],
+ "Roo.form.TriggerField" : [
+ "Roo.form.ComboBox",
+ "Roo.form.DateField",
+ "Roo.form.MonthField",
+ "Roo.form.Select"
+ ],
+ "Roo.form.ComboBox" : [
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested"
+ ],
+ "Roo.View" : [
+ "Roo.JsonView"
+ ],
+ "Roo.data.DataProxy" : [
+ "Roo.data.HttpProxy"
+ ],
+ "Roo.menu.Menu" : [
+ "Roo.menu.ColorMenu",
+ "Roo.menu.DateMenu"
+ ],
+ "Roo.bootstrap.form.TriggerField" : [
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.PhoneInput"
+ ],
+ "Roo.dd.DragDrop" : [
+ "Roo.dd.DD",
+ "Roo.dd.DDTarget"
+ ],
+ "Roo.tree.TreeNode" : [
+ "Roo.tree.AsyncTreeNode"
+ ],
+ "Roo.Button" : [
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button"
+ ],
+ "Roo.util.Observable" : [
+ "Roo.BasicDialog",
+ "Roo.BasicLayoutRegion",
+ "Roo.Button",
+ "Roo.Component",
+ "Roo.ContentPanel",
+ "Roo.Document",
+ "Roo.LayoutManager",
+ "Roo.Resizable",
+ "Roo.SplitBar",
+ "Roo.TabPanel",
+ "Roo.TabPanelItem",
+ "Roo.UpdateManager",
+ "Roo.View",
+ "Roo.XComponent",
+ "Roo.bootstrap.SplitBar",
+ "Roo.bootstrap.layout.Basic",
+ "Roo.bootstrap.panel.Content",
+ "Roo.bootstrap.panel.TabItem",
+ "Roo.bootstrap.panel.Tabs",
+ "Roo.data.Connection",
+ "Roo.data.DataProxy",
+ "Roo.data.Node",
+ "Roo.data.Store",
+ "Roo.data.Tree",
+ "Roo.dd.DragDrop",
+ "Roo.form.BasicForm",
+ "Roo.grid.AbstractGridView",
+ "Roo.grid.AbstractSelectionModel",
+ "Roo.grid.ColumnModel",
+ "Roo.grid.Grid",
+ "Roo.grid.GridView",
+ "Roo.menu.Menu",
+ "Roo.tree.DefaultSelectionModel",
+ "Roo.tree.MultiSelectionModel",
+ "Roo.tree.TreeLoader",
+ "Roo.util.ClickRepeater",
+ "Roo.util.MixedCollection"
+ ],
+ "Roo.bootstrap.layout.Manager" : [
+ "Roo.bootstrap.layout.Border"
+ ],
+ "Roo.Component" : [
+ "Roo.BoxComponent",
+ "Roo.CalendarPanel",
+ "Roo.ColorPalette",
+ "Roo.DatePicker",
+ "Roo.Editor",
+ "Roo.HtmlEditorCore",
+ "Roo.bootstrap.Component",
+ "Roo.form.Layout",
+ "Roo.menu.BaseItem"
+ ],
+ "Roo.BorderLayout" : [
+ "Roo.ReaderLayout"
+ ],
+ "Roo.menu.Item" : [
+ "Roo.menu.CheckItem"
+ ],
+ "Roo.bootstrap.form.TextArea" : [
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown"
+ ],
+ "Roo.form.Field" : [
+ "Roo.form.Checkbox",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.GridField",
+ "Roo.form.HtmlEditor",
+ "Roo.form.Signature",
+ "Roo.form.TextField"
+ ],
+ "Roo.form.BasicForm" : [
+ "Roo.form.Form"
+ ],
+ "Roo.SplitButton" : [
+ "Roo.Toolbar.SplitButton"
+ ],
+ "Roo.bootstrap.panel.Content" : [
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest"
+ ],
+ "Roo.BasicDialog" : [
+ "Roo.LayoutDialog"
+ ],
+ "Roo.menu.BaseItem" : [
+ "Roo.menu.Adapter",
+ "Roo.menu.Item",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem"
+ ],
+ "Roo.BoxComponent" : [
+ "Roo.form.ComboBoxArray.Item",
+ "Roo.form.Field",
+ "Roo.form.TextItem"
+ ],
+ "Roo.data.Store" : [
+ "Roo.data.JsonStore",
+ "Roo.data.SimpleStore"
+ ],
+ "Roo.dd.DDProxy" : [
+ "Roo.dd.DragSource",
+ "Roo.grid.SplitDragZone"
+ ],
+ "Roo.menu.Adapter" : [
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem"
+ ],
+ "Roo.tree.TreePanel" : [
+ "Roo.tree.ColumnTree"
+ ],
+ "Roo.bootstrap.layout.Basic" : [
+ "Roo.bootstrap.layout.Region"
+ ],
+ "Roo.form.TextField" : [
+ "Roo.form.ComboBoxArray",
+ "Roo.form.Hidden",
+ "Roo.form.NumberField",
+ "Roo.form.TextArea",
+ "Roo.form.TriggerField"
+ ],
+ "Roo.form.Checkbox" : [
+ "Roo.form.Radio"
+ ],
+ "Roo.bootstrap.form.Input" : [
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField"
+ ],
+ "Roo.grid.AbstractSelectionModel" : [
+ "Roo.grid.CellSelectionModel",
+ "Roo.grid.RowSelectionModel"
+ ],
+ "Roo.bootstrap.form.ComboBox" : [
+ "Roo.bootstrap.form.MoneyField"
+ ],
+ "Roo.dd.DDTarget" : [
+ "Roo.dd.DropTarget"
+ ],
+ "Roo.bootstrap.Button" : [
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ],
+ "Roo.bootstrap.Component" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Body",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Modal",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.Popover",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.TableBody",
+ "Roo.bootstrap.TableCell",
+ "Roo.bootstrap.TableRow",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Item",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.layout.Manager",
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Menu",
+ "Roo.bootstrap.menu.Separator",
+ "Roo.bootstrap.nav.Bar",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem"
+ ],
+ "Roo.data.Tree" : [
+ "Roo.tree.TreePanel"
+ ],
+ "Roo.dd.DD" : [
+ "Roo.dd.DDProxy"
+ ],
+ "Roo.form.TextArea" : [
+ "Roo.form.FCKeditor"
+ ],
+ "Roo.grid.Grid" : [
+ "Roo.grid.Calendar",
+ "Roo.grid.EditorGrid"
+ ],
+ "Roo.Editor" : [
+ "Roo.grid.GridEditor",
+ "Roo.tree.TreeEditor"
+ ],
+ "Roo.bootstrap.nav.Simplebar" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.nav.Headerbar"
+ ],
+ "Roo.data.Connection" : [
+ "Roo.Ajax"
+ ],
+ "Roo.dd.DragSource" : [
+ "Roo.dd.DragZone"
+ ],
+ "Roo.bootstrap.nav.Bar" : [
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "Roo.BasicLayoutRegion" : [
+ "Roo.LayoutRegion"
+ ],
+ "Roo.data.Node" : [
+ "Roo.tree.TreeNode"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.TextMetrics" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"Roo.util.TextMetrics.Instance" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"String" : {
"props" : [],
}
]
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"_global_" : {
"props" : [],
"params" : [],
"returns" : []
}
- ]
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
},
"this" : {
"props" : [],
"events" : [],
- "methods" : []
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "childClasses" : { },
+ "tree_children" : [],
+ "tree_parent" : []
}
}
\ No newline at end of file
projects / roojs1 / blobdiff