1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.Component</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.Component-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.Component-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.Component-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.Component-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.Component
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_Component.js.html">Roo/Component.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Component</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>, <a href="./Roo.CalendarPanel.html#constructor" roo:cls="Roo.CalendarPanel.html#constructor">Roo.CalendarPanel</a>, <a href="./Roo.ColorPalette.html#constructor" roo:cls="Roo.ColorPalette.html#constructor">Roo.ColorPalette</a>, <a href="./Roo.DatePicker.html#constructor" roo:cls="Roo.DatePicker.html#constructor">Roo.DatePicker</a>, <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>, <a href="./Roo.HtmlEditorCore.html#constructor" roo:cls="Roo.HtmlEditorCore.html#constructor">Roo.HtmlEditorCore</a>, <a href="./Roo.bootstrap.Alert.html#constructor" roo:cls="Roo.bootstrap.Alert.html#constructor">Roo.bootstrap.Alert</a>, <a href="./Roo.bootstrap.Body.html#constructor" roo:cls="Roo.bootstrap.Body.html#constructor">Roo.bootstrap.Body</a>, <a href="./Roo.bootstrap.Brick.html#constructor" roo:cls="Roo.bootstrap.Brick.html#constructor">Roo.bootstrap.Brick</a>, <a href="./Roo.bootstrap.Button.html#constructor" roo:cls="Roo.bootstrap.Button.html#constructor">Roo.bootstrap.Button</a>, <a href="./Roo.bootstrap.ButtonGroup.html#constructor" roo:cls="Roo.bootstrap.ButtonGroup.html#constructor">Roo.bootstrap.ButtonGroup</a>, <a href="./Roo.bootstrap.Calendar.html#constructor" roo:cls="Roo.bootstrap.Calendar.html#constructor">Roo.bootstrap.Calendar</a>, <a href="./Roo.bootstrap.CheckBox.html#constructor" roo:cls="Roo.bootstrap.CheckBox.html#constructor">Roo.bootstrap.CheckBox</a>, <a href="./Roo.bootstrap.Column.html#constructor" roo:cls="Roo.bootstrap.Column.html#constructor">Roo.bootstrap.Column</a>, <a href="./Roo.bootstrap.ComboBox.html#constructor" roo:cls="Roo.bootstrap.ComboBox.html#constructor">Roo.bootstrap.ComboBox</a>, <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>, <a href="./Roo.bootstrap.Container.html#constructor" roo:cls="Roo.bootstrap.Container.html#constructor">Roo.bootstrap.Container</a>, <a href="./Roo.bootstrap.DateField.html#constructor" roo:cls="Roo.bootstrap.DateField.html#constructor">Roo.bootstrap.DateField</a>, <a href="./Roo.bootstrap.DateSplitField.html#constructor" roo:cls="Roo.bootstrap.DateSplitField.html#constructor">Roo.bootstrap.DateSplitField</a>, <a href="./Roo.bootstrap.DocumentManager.html#constructor" roo:cls="Roo.bootstrap.DocumentManager.html#constructor">Roo.bootstrap.DocumentManager</a>, <a href="./Roo.bootstrap.DocumentSlider.html#constructor" roo:cls="Roo.bootstrap.DocumentSlider.html#constructor">Roo.bootstrap.DocumentSlider</a>, <a href="./Roo.bootstrap.DocumentViewer.html#constructor" roo:cls="Roo.bootstrap.DocumentViewer.html#constructor">Roo.bootstrap.DocumentViewer</a>, <a href="./Roo.bootstrap.Element.html#constructor" roo:cls="Roo.bootstrap.Element.html#constructor">Roo.bootstrap.Element</a>, <a href="./Roo.bootstrap.FieldLabel.html#constructor" roo:cls="Roo.bootstrap.FieldLabel.html#constructor">Roo.bootstrap.FieldLabel</a>, <a href="./Roo.bootstrap.Form.html#constructor" roo:cls="Roo.bootstrap.Form.html#constructor">Roo.bootstrap.Form</a>, <a href="./Roo.bootstrap.Graph.html#constructor" roo:cls="Roo.bootstrap.Graph.html#constructor">Roo.bootstrap.Graph</a>, <a href="./Roo.bootstrap.Header.html#constructor" roo:cls="Roo.bootstrap.Header.html#constructor">Roo.bootstrap.Header</a>, <a href="./Roo.bootstrap.HtmlEditor.html#constructor" roo:cls="Roo.bootstrap.HtmlEditor.html#constructor">Roo.bootstrap.HtmlEditor</a>, <a href="./Roo.bootstrap.Img.html#constructor" roo:cls="Roo.bootstrap.Img.html#constructor">Roo.bootstrap.Img</a>, <a href="./Roo.bootstrap.Input.html#constructor" roo:cls="Roo.bootstrap.Input.html#constructor">Roo.bootstrap.Input</a>, <a href="./Roo.bootstrap.LayoutMasonry.html#constructor" roo:cls="Roo.bootstrap.LayoutMasonry.html#constructor">Roo.bootstrap.LayoutMasonry</a>, <a href="./Roo.bootstrap.LayoutMasonryAuto.html#constructor" roo:cls="Roo.bootstrap.LayoutMasonryAuto.html#constructor">Roo.bootstrap.LayoutMasonryAuto</a>, <a href="./Roo.bootstrap.Link.html#constructor" roo:cls="Roo.bootstrap.Link.html#constructor">Roo.bootstrap.Link</a>, <a href="./Roo.bootstrap.LocationPicker.html#constructor" roo:cls="Roo.bootstrap.LocationPicker.html#constructor">Roo.bootstrap.LocationPicker</a>, <a href="./Roo.bootstrap.MasonryBrick.html#constructor" roo:cls="Roo.bootstrap.MasonryBrick.html#constructor">Roo.bootstrap.MasonryBrick</a>, <a href="./Roo.bootstrap.Menu.html#constructor" roo:cls="Roo.bootstrap.Menu.html#constructor">Roo.bootstrap.Menu</a>, <a href="./Roo.bootstrap.MenuItem.html#constructor" roo:cls="Roo.bootstrap.MenuItem.html#constructor">Roo.bootstrap.MenuItem</a>, <a href="./Roo.bootstrap.MenuSeparator.html#constructor" roo:cls="Roo.bootstrap.MenuSeparator.html#constructor">Roo.bootstrap.MenuSeparator</a>, <a href="./Roo.bootstrap.MessageBar.html#constructor" roo:cls="Roo.bootstrap.MessageBar.html#constructor">Roo.bootstrap.MessageBar</a>, <a href="./Roo.bootstrap.Modal.html#constructor" roo:cls="Roo.bootstrap.Modal.html#constructor">Roo.bootstrap.Modal</a>, <a href="./Roo.bootstrap.MoneyField.html#constructor" roo:cls="Roo.bootstrap.MoneyField.html#constructor">Roo.bootstrap.MoneyField</a>, <a href="./Roo.bootstrap.MonthField.html#constructor" roo:cls="Roo.bootstrap.MonthField.html#constructor">Roo.bootstrap.MonthField</a>, <a href="./Roo.bootstrap.NavGroup.html#constructor" roo:cls="Roo.bootstrap.NavGroup.html#constructor">Roo.bootstrap.NavGroup</a>, <a href="./Roo.bootstrap.NavHeaderbar.html#constructor" roo:cls="Roo.bootstrap.NavHeaderbar.html#constructor">Roo.bootstrap.NavHeaderbar</a>, <a href="./Roo.bootstrap.NavItem.html#constructor" roo:cls="Roo.bootstrap.NavItem.html#constructor">Roo.bootstrap.NavItem</a>, <a href="./Roo.bootstrap.NavProgressBar.html#constructor" roo:cls="Roo.bootstrap.NavProgressBar.html#constructor">Roo.bootstrap.NavProgressBar</a>, <a href="./Roo.bootstrap.NavProgressItem.html#constructor" roo:cls="Roo.bootstrap.NavProgressItem.html#constructor">Roo.bootstrap.NavProgressItem</a>, <a href="./Roo.bootstrap.NavSidebar.html#constructor" roo:cls="Roo.bootstrap.NavSidebar.html#constructor">Roo.bootstrap.NavSidebar</a>, <a href="./Roo.bootstrap.NavSidebarItem.html#constructor" roo:cls="Roo.bootstrap.NavSidebarItem.html#constructor">Roo.bootstrap.NavSidebarItem</a>, <a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>, <a href="./Roo.bootstrap.Navbar.html#constructor" roo:cls="Roo.bootstrap.Navbar.html#constructor">Roo.bootstrap.Navbar</a>, <a href="./Roo.bootstrap.NumberField.html#constructor" roo:cls="Roo.bootstrap.NumberField.html#constructor">Roo.bootstrap.NumberField</a>, <a href="./Roo.bootstrap.Pagination.html#constructor" roo:cls="Roo.bootstrap.Pagination.html#constructor">Roo.bootstrap.Pagination</a>, <a href="./Roo.bootstrap.PaginationItem.html#constructor" roo:cls="Roo.bootstrap.PaginationItem.html#constructor">Roo.bootstrap.PaginationItem</a>, <a href="./Roo.bootstrap.PagingToolbar.html#constructor" roo:cls="Roo.bootstrap.PagingToolbar.html#constructor">Roo.bootstrap.PagingToolbar</a>, <a href="./Roo.bootstrap.PhoneInput.html#constructor" roo:cls="Roo.bootstrap.PhoneInput.html#constructor">Roo.bootstrap.PhoneInput</a>, <a href="./Roo.bootstrap.Popover.html#constructor" roo:cls="Roo.bootstrap.Popover.html#constructor">Roo.bootstrap.Popover</a>, <a href="./Roo.bootstrap.Progress.html#constructor" roo:cls="Roo.bootstrap.Progress.html#constructor">Roo.bootstrap.Progress</a>, <a href="./Roo.bootstrap.ProgressBar.html#constructor" roo:cls="Roo.bootstrap.ProgressBar.html#constructor">Roo.bootstrap.ProgressBar</a>, <a href="./Roo.bootstrap.Radio.html#constructor" roo:cls="Roo.bootstrap.Radio.html#constructor">Roo.bootstrap.Radio</a>, <a href="./Roo.bootstrap.RadioSet.html#constructor" roo:cls="Roo.bootstrap.RadioSet.html#constructor">Roo.bootstrap.RadioSet</a>, <a href="./Roo.bootstrap.Row.html#constructor" roo:cls="Roo.bootstrap.Row.html#constructor">Roo.bootstrap.Row</a>, <a href="./Roo.bootstrap.SecurePass.html#constructor" roo:cls="Roo.bootstrap.SecurePass.html#constructor">Roo.bootstrap.SecurePass</a>, <a href="./Roo.bootstrap.Slider.html#constructor" roo:cls="Roo.bootstrap.Slider.html#constructor">Roo.bootstrap.Slider</a>, <a href="./Roo.bootstrap.TabGroup.html#constructor" roo:cls="Roo.bootstrap.TabGroup.html#constructor">Roo.bootstrap.TabGroup</a>, <a href="./Roo.bootstrap.TabPanel.html#constructor" roo:cls="Roo.bootstrap.TabPanel.html#constructor">Roo.bootstrap.TabPanel</a>, <a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a>, <a href="./Roo.bootstrap.TableBody.html#constructor" roo:cls="Roo.bootstrap.TableBody.html#constructor">Roo.bootstrap.TableBody</a>, <a href="./Roo.bootstrap.TableCell.html#constructor" roo:cls="Roo.bootstrap.TableCell.html#constructor">Roo.bootstrap.TableCell</a>, <a href="./Roo.bootstrap.TableRow.html#constructor" roo:cls="Roo.bootstrap.TableRow.html#constructor">Roo.bootstrap.TableRow</a>, <a href="./Roo.bootstrap.TextArea.html#constructor" roo:cls="Roo.bootstrap.TextArea.html#constructor">Roo.bootstrap.TextArea</a>, <a href="./Roo.bootstrap.TimeField.html#constructor" roo:cls="Roo.bootstrap.TimeField.html#constructor">Roo.bootstrap.TimeField</a>, <a href="./Roo.bootstrap.TriggerField.html#constructor" roo:cls="Roo.bootstrap.TriggerField.html#constructor">Roo.bootstrap.TriggerField</a>, <a href="./Roo.bootstrap.UploadCropbox.html#constructor" roo:cls="Roo.bootstrap.UploadCropbox.html#constructor">Roo.bootstrap.UploadCropbox</a>, <a href="./Roo.bootstrap.dash.NumberBox.html#constructor" roo:cls="Roo.bootstrap.dash.NumberBox.html#constructor">Roo.bootstrap.dash.NumberBox</a>, <a href="./Roo.bootstrap.dash.TabBox.html#constructor" roo:cls="Roo.bootstrap.dash.TabBox.html#constructor">Roo.bootstrap.dash.TabBox</a>, <a href="./Roo.bootstrap.dash.TabPane.html#constructor" roo:cls="Roo.bootstrap.dash.TabPane.html#constructor">Roo.bootstrap.dash.TabPane</a>, <a href="./Roo.bootstrap.layout.Border.html#constructor" roo:cls="Roo.bootstrap.layout.Border.html#constructor">Roo.bootstrap.layout.Border</a>, <a href="./Roo.bootstrap.layout.Manager.html#constructor" roo:cls="Roo.bootstrap.layout.Manager.html#constructor">Roo.bootstrap.layout.Manager</a>, <a href="./Roo.bootstrap.menu.Item.html#constructor" roo:cls="Roo.bootstrap.menu.Item.html#constructor">Roo.bootstrap.menu.Item</a>, <a href="./Roo.bootstrap.menu.Menu.html#constructor" roo:cls="Roo.bootstrap.menu.Menu.html#constructor">Roo.bootstrap.menu.Menu</a>, <a href="./Roo.bootstrap.menu.Separator.html#constructor" roo:cls="Roo.bootstrap.menu.Separator.html#constructor">Roo.bootstrap.menu.Separator</a>, <a href="./Roo.doc.Book.html#constructor" roo:cls="Roo.doc.Book.html#constructor">Roo.doc.Book</a>, <a href="./Roo.doc.Entry.html#constructor" roo:cls="Roo.doc.Entry.html#constructor">Roo.doc.Entry</a>, <a href="./Roo.doc.Example.html#constructor" roo:cls="Roo.doc.Example.html#constructor">Roo.doc.Example</a>, <a href="./Roo.doc.NavCategory.html#constructor" roo:cls="Roo.doc.NavCategory.html#constructor">Roo.doc.NavCategory</a>, <a href="./Roo.doc.Para.html#constructor" roo:cls="Roo.doc.Para.html#constructor">Roo.doc.Para</a>, <a href="./Roo.doc.Param.html#constructor" roo:cls="Roo.doc.Param.html#constructor">Roo.doc.Param</a>, <a href="./Roo.doc.Section.html#constructor" roo:cls="Roo.doc.Section.html#constructor">Roo.doc.Section</a>, <a href="./Roo.doc.Synopsis.html#constructor" roo:cls="Roo.doc.Synopsis.html#constructor">Roo.doc.Synopsis</a>, <a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a>, <a href="./Roo.form.Column.html#constructor" roo:cls="Roo.form.Column.html#constructor">Roo.form.Column</a>, <a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a>, <a href="./Roo.form.ComboBoxArray.html#constructor" roo:cls="Roo.form.ComboBoxArray.html#constructor">Roo.form.ComboBoxArray</a>, <a href="./Roo.form.ComboBoxArray.Item.html#constructor" roo:cls="Roo.form.ComboBoxArray.Item.html#constructor">Roo.form.ComboBoxArray.Item</a>, <a href="./Roo.form.ComboCheck.html#constructor" roo:cls="Roo.form.ComboCheck.html#constructor">Roo.form.ComboCheck</a>, <a href="./Roo.form.DateField.html#constructor" roo:cls="Roo.form.DateField.html#constructor">Roo.form.DateField</a>, <a href="./Roo.form.DayPicker.html#constructor" roo:cls="Roo.form.DayPicker.html#constructor">Roo.form.DayPicker</a>, <a href="./Roo.form.DisplayField.html#constructor" roo:cls="Roo.form.DisplayField.html#constructor">Roo.form.DisplayField</a>, <a href="./Roo.form.FCKeditor.html#constructor" roo:cls="Roo.form.FCKeditor.html#constructor">Roo.form.FCKeditor</a>, <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>, <a href="./Roo.form.FieldSet.html#constructor" roo:cls="Roo.form.FieldSet.html#constructor">Roo.form.FieldSet</a>, <a href="./Roo.form.GridField.html#constructor" roo:cls="Roo.form.GridField.html#constructor">Roo.form.GridField</a>, <a href="./Roo.form.Hidden.html#constructor" roo:cls="Roo.form.Hidden.html#constructor">Roo.form.Hidden</a>, <a href="./Roo.form.HtmlEditor.html#constructor" roo:cls="Roo.form.HtmlEditor.html#constructor">Roo.form.HtmlEditor</a>, <a href="./Roo.form.Layout.html#constructor" roo:cls="Roo.form.Layout.html#constructor">Roo.form.Layout</a>, <a href="./Roo.form.MonthField.html#constructor" roo:cls="Roo.form.MonthField.html#constructor">Roo.form.MonthField</a>, <a href="./Roo.form.NumberField.html#constructor" roo:cls="Roo.form.NumberField.html#constructor">Roo.form.NumberField</a>, <a href="./Roo.form.Radio.html#constructor" roo:cls="Roo.form.Radio.html#constructor">Roo.form.Radio</a>, <a href="./Roo.form.Row.html#constructor" roo:cls="Roo.form.Row.html#constructor">Roo.form.Row</a>, <a href="./Roo.form.Select.html#constructor" roo:cls="Roo.form.Select.html#constructor">Roo.form.Select</a>, <a href="./Roo.form.Signature.html#constructor" roo:cls="Roo.form.Signature.html#constructor">Roo.form.Signature</a>, <a href="./Roo.form.TextArea.html#constructor" roo:cls="Roo.form.TextArea.html#constructor">Roo.form.TextArea</a>, <a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>, <a href="./Roo.form.TriggerField.html#constructor" roo:cls="Roo.form.TriggerField.html#constructor">Roo.form.TriggerField</a>, <a href="./Roo.grid.GridEditor.html#constructor" roo:cls="Roo.grid.GridEditor.html#constructor">Roo.grid.GridEditor</a>, <a href="./Roo.mailer.Block.html#constructor" roo:cls="Roo.mailer.Block.html#constructor">Roo.mailer.Block</a>, <a href="./Roo.mailer.Body.html#constructor" roo:cls="Roo.mailer.Body.html#constructor">Roo.mailer.Body</a>, <a href="./Roo.mailer.BodyContainer.html#constructor" roo:cls="Roo.mailer.BodyContainer.html#constructor">Roo.mailer.BodyContainer</a>, <a href="./Roo.mailer.Column.html#constructor" roo:cls="Roo.mailer.Column.html#constructor">Roo.mailer.Column</a>, <a href="./Roo.menu.Adapter.html#constructor" roo:cls="Roo.menu.Adapter.html#constructor">Roo.menu.Adapter</a>, <a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a>, <a href="./Roo.menu.CheckItem.html#constructor" roo:cls="Roo.menu.CheckItem.html#constructor">Roo.menu.CheckItem</a>, <a href="./Roo.menu.ColorItem.html#constructor" roo:cls="Roo.menu.ColorItem.html#constructor">Roo.menu.ColorItem</a>, <a href="./Roo.menu.DateItem.html#constructor" roo:cls="Roo.menu.DateItem.html#constructor">Roo.menu.DateItem</a>, <a href="./Roo.menu.Item.html#constructor" roo:cls="Roo.menu.Item.html#constructor">Roo.menu.Item</a>, <a href="./Roo.menu.Separator.html#constructor" roo:cls="Roo.menu.Separator.html#constructor">Roo.menu.Separator</a>, <a href="./Roo.menu.TextItem.html#constructor" roo:cls="Roo.menu.TextItem.html#constructor">Roo.menu.TextItem</a>, <a href="./Roo.tree.TreeEditor.html#constructor" roo:cls="Roo.tree.TreeEditor.html#constructor">Roo.tree.TreeEditor</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 Base class for all major Roo components. All subclasses of Component can automatically participate in the standard<br/>Roo component lifecycle of creation, rendering and destruction. They also have automatic support for basic hide/show<br/>and enable/disable behavior. Component allows any subclass to be lazy-rendered into any {<b>link</b> Roo.Container} and<br/>to be automatically registered with the {<b>link</b> Roo.ComponentMgr} so that it can be referenced at any time via {<b>link</b> Roo.getCmp}.<br/>All visual components (widgets) that require rendering into a layout should subclass Component.
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.Component';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.Component.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.Component-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0 notInherited">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
139 <div class="fixedFont">
140 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
146 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
151 which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'
167 <tr class="config-row expandable config-row-alt1 notInherited">
168 <td class="micon"><a class="exi" href="#expand"> </a></td>
171 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
172 <div class="fixedFont">
173 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
179 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
184 Whether the component can move the Dom node when rendering (defaults to true).
200 <tr class="config-row expandable config-row-alt0 notInherited">
201 <td class="micon"><a class="exi" href="#expand"> </a></td>
204 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
205 <div class="fixedFont">
206 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
212 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
217 CSS class added to the component when it is disabled (defaults to "x-item-disabled").
233 <tr class="config-row expandable config-row-alt1 notInherited">
234 <td class="micon"><a class="exi" href="#expand"> </a></td>
237 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
238 <div class="fixedFont">
239 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
245 <div class="short">How this component should hidden.</div>
250 How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".
251 <BR/>Possible Values: display, visibility
266 <tr class="config-row expandable config-row-alt0">
267 <td class="micon"><a class="exi" href="#expand"> </a></td>
270 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
271 <div class="fixedFont">
272 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
278 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
283 list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre>
293 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
309 <!-- ============================== public properties ==================== -->
313 <a id="Roo.Component-props"></a>
319 <table cellspacing="0" class="member-table">
320 <caption class="Empty">Public Properties - Has None</caption>
326 <!-- ============================== methods summary / details ======================== -->
329 <a id="Roo.Component-methods"></a>
330 <!-- constructor?? -->
337 <!-- then dynamics first -->
344 <table cellspacing="0" class="member-table">
345 <caption>Public Methods</caption>
347 <th class="sig-header" colspan="2">Method</th>
348 <th class="msource-header">Defined By</th>
358 <tr class="method-row config-row-alt0 expandable notInherited">
359 <td class="micon"><a class="exi" href="#expand"> </a></td>
363 <a id="Roo-method-Component" name=".Component"></a>
364 <div class="fixedFont">
365 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Component</b>
367 (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object <B><i>config</i></B>)
375 <div class="short">Create a new Roo.Component</div>
382 Create a new Roo.Component
385 <dl class="detailList">
386 <dt class="heading">Parameters:</dt>
389 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object</span> <b>config</b>
392 <dd>The configuration options. If an element is passed, it is set as the internal<br/>element and its id used as the component id. If a string is passed, it is assumed to be the id of an existing element<br/>and is used as the component id. Otherwise, it is assumed to be a standard config object and is applied to the component.</dd>
416 <tr class="method-row config-row-alt1 expandable">
417 <td class="micon"><a class="exi" href="#expand"> </a></td>
421 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
422 <div class="fixedFont">
423 <span class="attributes"></span><b class="itemname">addEvents</b>
425 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
432 <div class="short">Used to define events on this Observable</div>
438 Used to define events on this Observable
445 <dl class="detailList">
446 <dt class="heading">Parameters:</dt>
449 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
452 <dd>The object with the events defined</dd>
472 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
478 <tr class="method-row config-row-alt0 expandable">
479 <td class="micon"><a class="exi" href="#expand"> </a></td>
483 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
484 <div class="fixedFont">
485 <span class="attributes"></span><b class="itemname">addListener</b>
487 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
494 <div class="short">Appends an event handler to this component</div>
500 Appends an event handler to this component
507 <dl class="detailList">
508 <dt class="heading">Parameters:</dt>
511 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
514 <dd>The type of event to listen for</dd>
517 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
520 <dd>The method the event invokes</dd>
523 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
526 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
529 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
532 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
552 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
558 <tr class="method-row config-row-alt1 expandable notInherited">
559 <td class="micon"><a class="exi" href="#expand"> </a></td>
563 <a id="Roo.Component-method-destroy" name=".destroy"></a>
564 <div class="fixedFont">
565 <span class="attributes"></span><b class="itemname">destroy</b>
574 <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.</div>
580 Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.
609 <tr class="method-row config-row-alt0 expandable notInherited">
610 <td class="micon"><a class="exi" href="#expand"> </a></td>
614 <a id="Roo.Component-method-disable" name=".disable"></a>
615 <div class="fixedFont">
616 <span class="attributes"></span><b class="itemname">disable</b>
624 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
633 <div class="short">Disable this component.</div>
639 Disable this component.
650 <dl class="detailList">
651 <dt class="heading">Returns:</dt>
653 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
675 <tr class="method-row config-row-alt1 expandable notInherited">
676 <td class="micon"><a class="exi" href="#expand"> </a></td>
680 <a id="Roo.Component-method-enable" name=".enable"></a>
681 <div class="fixedFont">
682 <span class="attributes"></span><b class="itemname">enable</b>
690 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
699 <div class="short">Enable this component.</div>
705 Enable this component.
716 <dl class="detailList">
717 <dt class="heading">Returns:</dt>
719 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
741 <tr class="method-row config-row-alt0 expandable">
742 <td class="micon"><a class="exi" href="#expand"> </a></td>
746 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
747 <div class="fixedFont">
748 <span class="attributes"></span><b class="itemname">fireEvent</b>
750 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
756 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
765 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
771 Fires the specified event with the passed parameters (minus the event name).
778 <dl class="detailList">
779 <dt class="heading">Parameters:</dt>
782 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
788 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
791 <dd>Variable number of parameters are passed to handlers</dd>
799 <dl class="detailList">
800 <dt class="heading">Returns:</dt>
802 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
818 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
824 <tr class="method-row config-row-alt1 expandable notInherited">
825 <td class="micon"><a class="exi" href="#expand"> </a></td>
829 <a id="Roo.Component-method-focus" name=".focus"></a>
830 <div class="fixedFont">
831 <span class="attributes"></span><b class="itemname">focus</b>
833 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
839 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
848 <div class="short">Try to focus this component.</div>
854 Try to focus this component.
861 <dl class="detailList">
862 <dt class="heading">Parameters:</dt>
865 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>selectText</b>
868 <dd>True to also select the text in this component (if applicable)</dd>
876 <dl class="detailList">
877 <dt class="heading">Returns:</dt>
879 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
901 <tr class="method-row config-row-alt0 expandable notInherited">
902 <td class="micon"><a class="exi" href="#expand"> </a></td>
906 <a id="Roo.Component-method-getEl" name=".getEl"></a>
907 <div class="fixedFont">
908 <span class="attributes"></span><b class="itemname">getEl</b>
916 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
925 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
931 Returns the underlying {<b>link</b> Roo.Element}.
942 <dl class="detailList">
943 <dt class="heading">Returns:</dt>
945 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
967 <tr class="method-row config-row-alt1 expandable notInherited">
968 <td class="micon"><a class="exi" href="#expand"> </a></td>
972 <a id="Roo.Component-method-getId" name=".getId"></a>
973 <div class="fixedFont">
974 <span class="attributes"></span><b class="itemname">getId</b>
982 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
991 <div class="short">Returns the id of this component.</div>
997 Returns the id of this component.
1008 <dl class="detailList">
1009 <dt class="heading">Returns:</dt>
1011 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1025 <td class="msource">
1033 <tr class="method-row config-row-alt0 expandable">
1034 <td class="micon"><a class="exi" href="#expand"> </a></td>
1038 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1039 <div class="fixedFont">
1040 <span class="attributes"></span><b class="itemname">hasListener</b>
1042 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1048 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1057 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1063 Checks to see if this object has any listeners for a specified event
1070 <dl class="detailList">
1071 <dt class="heading">Parameters:</dt>
1074 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1077 <dd>The name of the event to check for</dd>
1085 <dl class="detailList">
1086 <dt class="heading">Returns:</dt>
1088 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1102 <td class="msource">
1104 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1110 <tr class="method-row config-row-alt1 expandable notInherited">
1111 <td class="micon"><a class="exi" href="#expand"> </a></td>
1115 <a id="Roo.Component-method-hide" name=".hide"></a>
1116 <div class="fixedFont">
1117 <span class="attributes"></span><b class="itemname">hide</b>
1125 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1134 <div class="short">Hide this component.</div>
1140 Hide this component.
1151 <dl class="detailList">
1152 <dt class="heading">Returns:</dt>
1154 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1168 <td class="msource">
1176 <tr class="method-row config-row-alt0 expandable notInherited">
1177 <td class="micon"><a class="exi" href="#expand"> </a></td>
1181 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1182 <div class="fixedFont">
1183 <span class="attributes"></span><b class="itemname">isVisible</b>
1192 <div class="short">Returns true if this component is visible.</div>
1198 Returns true if this component is visible.
1219 <td class="msource">
1227 <tr class="method-row config-row-alt1 expandable">
1228 <td class="micon"><a class="exi" href="#expand"> </a></td>
1232 <a id="Roo.util.Observable-method-on" name=".on"></a>
1233 <div class="fixedFont">
1234 <span class="attributes"></span><b class="itemname">on</b>
1236 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1243 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1249 Appends an event handler to this element (shorthand for addListener)
1256 <dl class="detailList">
1257 <dt class="heading">Parameters:</dt>
1260 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1263 <dd>The type of event to listen for</dd>
1266 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1269 <dd>The method the event invokes</dd>
1272 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1275 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1278 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1299 <td class="msource">
1301 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1307 <tr class="method-row config-row-alt0 expandable">
1308 <td class="micon"><a class="exi" href="#expand"> </a></td>
1312 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1313 <div class="fixedFont">
1314 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1323 <div class="short">Removes all listeners for this object</div>
1329 Removes all listeners for this object
1350 <td class="msource">
1352 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1358 <tr class="method-row config-row-alt1 expandable">
1359 <td class="micon"><a class="exi" href="#expand"> </a></td>
1363 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1364 <div class="fixedFont">
1365 <span class="attributes"></span><b class="itemname">removeListener</b>
1367 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1374 <div class="short">Removes a listener</div>
1387 <dl class="detailList">
1388 <dt class="heading">Parameters:</dt>
1391 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1394 <dd>The type of event to listen for</dd>
1397 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1400 <dd>The handler to remove</dd>
1403 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1406 <dd>(optional) The scope (this object) for the handler</dd>
1424 <td class="msource">
1426 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1432 <tr class="method-row config-row-alt0 expandable notInherited">
1433 <td class="micon"><a class="exi" href="#expand"> </a></td>
1437 <a id="Roo.Component-method-render" name=".render"></a>
1438 <div class="fixedFont">
1439 <span class="attributes"></span><b class="itemname">render</b>
1441 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1448 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1454 If this is a lazy rendering component, render it to its container element.
1461 <dl class="detailList">
1462 <dt class="heading">Parameters:</dt>
1465 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1468 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1486 <td class="msource">
1494 <tr class="method-row config-row-alt1 expandable notInherited">
1495 <td class="micon"><a class="exi" href="#expand"> </a></td>
1499 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1500 <div class="fixedFont">
1501 <span class="attributes"></span><b class="itemname">setDisabled</b>
1503 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1510 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1516 Convenience function for setting disabled/enabled by boolean.
1523 <dl class="detailList">
1524 <dt class="heading">Parameters:</dt>
1527 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>disabled</b>
1548 <td class="msource">
1556 <tr class="method-row config-row-alt0 expandable notInherited">
1557 <td class="micon"><a class="exi" href="#expand"> </a></td>
1561 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
1562 <div class="fixedFont">
1563 <span class="attributes"></span><b class="itemname">setVisible</b>
1565 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1571 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1580 <div class="short">Convenience function to hide or show this component by boolean.</div>
1586 Convenience function to hide or show this component by boolean.
1593 <dl class="detailList">
1594 <dt class="heading">Parameters:</dt>
1597 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>visible</b>
1600 <dd>True to show, false to hide</dd>
1608 <dl class="detailList">
1609 <dt class="heading">Returns:</dt>
1611 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1625 <td class="msource">
1633 <tr class="method-row config-row-alt1 expandable notInherited">
1634 <td class="micon"><a class="exi" href="#expand"> </a></td>
1638 <a id="Roo.Component-method-show" name=".show"></a>
1639 <div class="fixedFont">
1640 <span class="attributes"></span><b class="itemname">show</b>
1648 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1657 <div class="short">Show this component.</div>
1663 Show this component.
1674 <dl class="detailList">
1675 <dt class="heading">Returns:</dt>
1677 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1691 <td class="msource">
1699 <tr class="method-row config-row-alt0 expandable">
1700 <td class="micon"><a class="exi" href="#expand"> </a></td>
1704 <a id="Roo.util.Observable-method-un" name=".un"></a>
1705 <div class="fixedFont">
1706 <span class="attributes"></span><b class="itemname">un</b>
1708 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1715 <div class="short">Removes a listener (shorthand for removeListener)</div>
1721 Removes a listener (shorthand for removeListener)
1728 <dl class="detailList">
1729 <dt class="heading">Parameters:</dt>
1732 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1735 <dd>The type of event to listen for</dd>
1738 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1741 <dd>The handler to remove</dd>
1744 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1747 <dd>(optional) The scope (this object) for the handler</dd>
1765 <td class="msource">
1767 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1776 <!-- ============================== events summary / details ======================== -->
1779 <a id="Roo.Component-events"></a>
1788 <table cellspacing="0" class="member-table">
1789 <caption>Events</caption>
1792 <th class="sig-header" colspan="2">Event</th>
1793 <th class="msource-header">Defined By</th>
1802 <tr class="method-row expandable config-row-alt0 notInherited">
1803 <td class="micon"><a class="exi" href="#expand"> </a></td>
1806 <a id="Roo.Component-event-*beforedestroy"></a>
1808 <div class="fixedFont">
1809 <b class="itemname">beforedestroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1815 <div class="short">Fires before the component is destroyed.
1821 Fires before the component is destroyed. Return false to stop the destroy.
1827 <dl class="detailList">
1828 <dt class="heading">Parameters:</dt>
1831 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1852 <td class="msource">
1857 <tr class="method-row expandable config-row-alt1 notInherited">
1858 <td class="micon"><a class="exi" href="#expand"> </a></td>
1861 <a id="Roo.Component-event-*beforehide"></a>
1863 <div class="fixedFont">
1864 <b class="itemname">beforehide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1870 <div class="short">Fires before the component is hidden.
1876 Fires before the component is hidden. Return false to stop the hide.
1882 <dl class="detailList">
1883 <dt class="heading">Parameters:</dt>
1886 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1907 <td class="msource">
1912 <tr class="method-row expandable config-row-alt0 notInherited">
1913 <td class="micon"><a class="exi" href="#expand"> </a></td>
1916 <a id="Roo.Component-event-*beforerender"></a>
1918 <div class="fixedFont">
1919 <b class="itemname">beforerender</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1925 <div class="short">Fires before the component is rendered.
1931 Fires before the component is rendered. Return false to stop the render.
1937 <dl class="detailList">
1938 <dt class="heading">Parameters:</dt>
1941 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1962 <td class="msource">
1967 <tr class="method-row expandable config-row-alt1 notInherited">
1968 <td class="micon"><a class="exi" href="#expand"> </a></td>
1971 <a id="Roo.Component-event-*beforeshow"></a>
1973 <div class="fixedFont">
1974 <b class="itemname">beforeshow</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1980 <div class="short">Fires before the component is shown.
1986 Fires before the component is shown. Return false to stop the show.
1992 <dl class="detailList">
1993 <dt class="heading">Parameters:</dt>
1996 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2017 <td class="msource">
2022 <tr class="method-row expandable config-row-alt0 notInherited">
2023 <td class="micon"><a class="exi" href="#expand"> </a></td>
2026 <a id="Roo.Component-event-*destroy"></a>
2028 <div class="fixedFont">
2029 <b class="itemname">destroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2035 <div class="short">Fires after the component is destroyed.
2041 Fires after the component is destroyed.
2047 <dl class="detailList">
2048 <dt class="heading">Parameters:</dt>
2051 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2072 <td class="msource">
2077 <tr class="method-row expandable config-row-alt1 notInherited">
2078 <td class="micon"><a class="exi" href="#expand"> </a></td>
2081 <a id="Roo.Component-event-*disable"></a>
2083 <div class="fixedFont">
2084 <b class="itemname">disable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2090 <div class="short">Fires after the component is disabled.
2096 Fires after the component is disabled.
2102 <dl class="detailList">
2103 <dt class="heading">Parameters:</dt>
2106 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2127 <td class="msource">
2132 <tr class="method-row expandable config-row-alt0 notInherited">
2133 <td class="micon"><a class="exi" href="#expand"> </a></td>
2136 <a id="Roo.Component-event-*enable"></a>
2138 <div class="fixedFont">
2139 <b class="itemname">enable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2145 <div class="short">Fires after the component is enabled.
2151 Fires after the component is enabled.
2157 <dl class="detailList">
2158 <dt class="heading">Parameters:</dt>
2161 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2182 <td class="msource">
2187 <tr class="method-row expandable config-row-alt1 notInherited">
2188 <td class="micon"><a class="exi" href="#expand"> </a></td>
2191 <a id="Roo.Component-event-*hide"></a>
2193 <div class="fixedFont">
2194 <b class="itemname">hide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2200 <div class="short">Fires after the component is hidden.
2206 Fires after the component is hidden.
2212 <dl class="detailList">
2213 <dt class="heading">Parameters:</dt>
2216 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2237 <td class="msource">
2242 <tr class="method-row expandable config-row-alt0 notInherited">
2243 <td class="micon"><a class="exi" href="#expand"> </a></td>
2246 <a id="Roo.Component-event-*render"></a>
2248 <div class="fixedFont">
2249 <b class="itemname">render</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2255 <div class="short">Fires after the component is rendered.
2261 Fires after the component is rendered.
2267 <dl class="detailList">
2268 <dt class="heading">Parameters:</dt>
2271 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2292 <td class="msource">
2297 <tr class="method-row expandable config-row-alt1 notInherited">
2298 <td class="micon"><a class="exi" href="#expand"> </a></td>
2301 <a id="Roo.Component-event-*show"></a>
2303 <div class="fixedFont">
2304 <b class="itemname">show</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2310 <div class="short">Fires after the component is shown.
2316 Fires after the component is shown.
2322 <dl class="detailList">
2323 <dt class="heading">Parameters:</dt>
2326 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2347 <td class="msource">
2359 <!-- ============================== footer ================================= -->
2360 <div class="fineprint" style="clear:both">
2362 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Apr 23 2018 17:33:44 GMT+0800 (HKT)
2364 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>