1 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
4 <title>RooJS(1) Generated Documentation</title>
10 <title>RooJS (1) - Manual</title>
15 font:normal 11px tahoma,arial,helvetica,sans-serif;
20 <a href="../docs" target="_top"><h1> View Documentation Interface </h1></a>
22 <h3> Download Latest Build (done daily) <a href="http://devel.akbkhome.com/roojs1-current.tgz">roojs1-current.tgz</a></h3>
23 <h3> Join in <code style="color:red">git clone http://git.roojs.org/roojs1</code> and send patches to alan@roojs.com</h3>
25 <h3 id="toc0"> RooJS1 Documentation Contents</h3>
26 <TABLE><TR><TD valign="top">
29 <li><a href="../docs/symbols/Roo.html" >Roo</a> Core Class - Essential Reading</li>
30 <li><b> Dom / CSS / Text</b><ul>
31 <li>Roo.util.<a href="../docs/symbols/Roo.util.CSS.html" >CSS</a></li>
32 <li>Roo.util.<a href="../docs/symbols/Roo.util.Format.html" >Format</a> Various Text Formating / Encoding</li>
33 <li>Roo.<a href="../docs/symbols/Roo.DomHelper.html" >DomHelper</a> DOM creation </li>
34 <li>Roo.<a href="../docs/symbols/Roo.DomQuery.html" >DomQuery</a> DOM locating elements</li>
35 <li>Roo.util.<a href="../docs/symbols/Roo.util.TextMetrics.html" >TextMetrics</a> Text size calculations</li>
37 <li><b>Element / Selection</b><ul>
38 <li>Roo.<a href="../docs/symbols/Roo.Element.html" >Element</a> Core Element methods (see also Roo.get())</li>
39 <li>Roo.<a href="../docs/symbols/Roo.CompositeElement.html" >CompositeElement</a></li>
40 <li>Roo.<a href="../docs/symbols/Roo.CompositeElementLite.html" >CompositeElementLite</a></li>
42 <li><b>Effects / Masks / Tips</b><ul>
43 <li>Roo.<a href="../docs/symbols/Roo.Fx.html" >Fx</a></li>
44 <li>Roo.<a href="../docs/symbols/Roo.LoadMask.html" >LoadMask</a></li>
45 <li>Roo.<a href="../docs/symbols/Roo.QuickTips.html" >QuickTips</a></li>
46 <li>Roo.<a href="../docs/symbols/Roo.Resizable.html" >Resizable</a></li>
47 <li><b>Examples</b><ul>
48 <li><a href="../examples/resizable/basic.html" >Resizing elements</a> With animation, snapping etc. (Works, needs a few replacement images)</li>
55 <li>Roo.state.<a href="../docs/symbols/Roo.state.CookieProvider.html" >CookieProvider</a></li>
60 <li><b>Drag and Drop</b><ul>
61 <li><a href="../docs/symbols/Roo.dd.DD.html" >Roo.dd.DD</a></li>
62 <li><a href="../docs/symbols/Roo.dd.DDProxy.html" >Roo.dd.DDProxy</a></li>
63 <li><a href="../docs/symbols/Roo.dd.DDTarget.html" >Roo.dd.DDTarget</a></li>
64 <li><a href="../docs/symbols/Roo.dd.DragDrop.html" >Roo.dd.DragDrop</a></li>
65 <li><a href="../docs/symbols/Roo.dd.DragDropMgr.html" >Roo.dd.DragDropMgr</a></li>
66 <li><a href="../docs/symbols/Roo.dd.DragZone.html" >Roo.dd.DragZone</a></li>
67 <li><a href="../docs/symbols/Roo.dd.DropTarget.html" >Roo.dd.DropTarget</a></li>
68 <li><a href="../docs/symbols/Roo.dd.DropZone.html" >Roo.dd.DropZone</a></li>
69 <li><a href="../docs/symbols/Roo.dd.Registry.html" >Roo.dd.Registry</a></li>
70 <li><a href="../docs/symbols/Roo.dd.ScrollManager.html" >Roo.dd.ScrollManager</a></li>
71 <li><a href="../docs/symbols/Roo.dd.StatusProxy.html" >Roo.dd.StatusProxy</a></li>
73 <li><b>Signals / Events</b><ul>
74 <li><a href="../docs/symbols/Roo.util.Observable.html" >Roo.util.Observable</a></li>
75 <li><a href="../docs/symbols/Roo.util.DelayedTask.html" >Roo.util.DelayedTask</a></li>
76 <li><a href="../docs/symbols/Roo.util.TaskRunner.html" >Roo.util.TaskRunner</a></li>
77 <li><a href="../docs/symbols/Roo.EventObject.html" >Roo.EventObject</a></li>
78 <li><a href="../docs/symbols/Roo.Shadow.html" >Roo.Shadow</a></li>
79 <li><a href="../docs/symbols/Roo.util.ClickRepeater.html" >Roo.util.ClickRepeater</a></li>
82 <li><a href="../docs/symbols/Roo.data.Connection.html" >Roo.data.Connection</a></li>
83 <li><a href="../docs/symbols/Roo.Ajax.html" >Roo.Ajax</a></li>
86 <li><a href="../docs/symbols/Roo.util.MixedCollection.html" >Roo.util.MixedCollection</a></li>
87 <li><a href="../docs/symbols/Roo.data.JsonStore.html" >Roo.data.JsonStore</a></li>
88 <li><a href="../docs/symbols/Roo.data.Store.html" >Roo.data.Store</a></li>
89 <li><a href="../docs/symbols/Roo.data.SimpleStore.html" >Roo.data.SimpleStore</a></li>
90 <li><a href="../docs/symbols/Roo.data.Record.html" >Roo.data.Record</a></li>
91 <li><a href="../docs/symbols/Roo.data.SortTypes.html" >Roo.data.SortTypes</a></li>
93 <li><b>Data Readers</b><ul>
94 <li><a href="../docs/symbols/Roo.data.ArrayReader.html" >Roo.data.ArrayReader</a></li>
95 <li><a href="../docs/symbols/Roo.data.DataReader.html" >Roo.data.DataReader</a></li>
96 <li><a href="../docs/symbols/Roo.data.JsonReader.html" >Roo.data.JsonReader</a></li>
97 <li><a href="../docs/symbols/Roo.data.XmlReader.html" >Roo.data.XmlReader</a></li>
99 <li><b>Data Proxies</b><ul>
100 <li><a href="../docs/symbols/Roo.data.DataProxy.html" >Roo.data.DataProxy</a></li>
101 <li><a href="../docs/symbols/Roo.data.HttpProxy.html" >Roo.data.HttpProxy</a></li>
102 <li><a href="../docs/symbols/Roo.data.MemoryProxy.html" >Roo.data.MemoryProxy</a></li>
103 <li><a href="../docs/symbols/Roo.data.ScriptTagProxy.html" >Roo.data.ScriptTagProxy</a></li>
105 <li><b>Tree Data</b><ul>
106 <li><a href="../docs/symbols/Roo.data.Node.html" >Roo.data.Node</a></li>
107 <li><a href="../docs/symbols/Roo.data.Tree.html" >Roo.data.Tree</a></li>
110 <li><a href="../docs/symbols/Roo.KeyMap.html" >Roo.KeyMap</a></li>
111 <li><a href="../docs/symbols/Roo.KeyNav.html" >Roo.KeyNav</a></li>
113 <li><b>Managers</b><ul>
114 <li><a href="../docs/symbols/Roo.ComponentMgr.html" >Roo.ComponentMgr</a></li>
115 <li><a href="../docs/symbols/Roo.DialogManager.html" >Roo.DialogManager</a></li>
116 <li><a href="../docs/symbols/Roo.EventManager.html" >Roo.EventManager</a></li>
117 <li><a href="../docs/symbols/Roo.LayoutManager.html" >Roo.LayoutManager</a></li>
118 <li><a href="../docs/symbols/Roo.UpdateManager.html" >Roo.UpdateManager</a></li>
119 <li><a href="../docs/symbols/Roo.state.Manager.html" >Roo.state.Manager</a></li>
121 <li><b>Templates</b><ul>
122 <li><a href="../docs/symbols/Roo.MasterTemplate.html" >Roo.MasterTemplate</a></li>
123 <li><a href="../docs/symbols/Roo.Template.html" >Roo.Template</a></li>
128 <b>Abstract Base Classes</b></p>
131 <li><a href="../docs/symbols/Roo.BoxComponent.html" >Roo.BoxComponent</a></li>
132 <li><a href="../docs/symbols/Roo.Component.html" >Roo.Component</a></li>
133 <li><a href="../docs/symbols/Roo.form.Field.html" >Roo.form.Field</a></li>
134 <li><a href="../docs/symbols/Roo.form.Layout.html" >Roo.form.Layout</a></li>
135 <li><a href="../docs/symbols/Roo.form.TriggerField.html" >Roo.form.TriggerField</a></li>
136 <li><a href="../docs/symbols/Roo.grid.AbstractGridView.html" >Roo.grid.AbstractGridView</a></li>
137 <li><a href="../docs/symbols/Roo.grid.AbstractSelectionModel.html" >Roo.grid.AbstractSelectionModel</a></li>
138 <li><a href="../docs/symbols/Roo.menu.Adapter.html" >Roo.menu.Adapter</a></li>
139 <li><a href="../docs/symbols/Roo.menu.BaseItem.html" >Roo.menu.BaseItem</a></li>
140 <li><a href="../docs/symbols/Roo.menu.Item.html" >Roo.menu.Item</a> </li>
141 <li><a href="../docs/symbols/Roo.state.Provider.html" >Roo.state.Provider</a></li>
142 <li><a href="../docs/symbols/Roo.Editor.html" >Roo.Editor</a></li>
143 <li><a href="../docs/symbols/Roo.Toolbar.Item.html" >Roo.Toolbar.Item</a></li>
146 </TD><TD valign="top">
147 <p><b>Widgets</b></p>
150 <li><a href="http://www.roojs.com/trac/wiki../Gallery" >Gallery</a></li>
151 <li><b>Windows and Dialogs</b><ul>
152 <li>Roo.<a href="../docs/symbols/Roo.BasicDialog.html" >BasicDialog</a></li>
153 <li>Roo.<a href="../docs/symbols/Roo.LayoutDialog.html" >LayoutDialog</a></li>
154 <li>Roo.<a href="../docs/symbols/Roo.MessageBox.html" >MessageBox</a></li>
155 <li><b>Examples</b><ul>
156 <li><a href="../examples/dialog/hello.html" >Simple Hello World</a></li>
157 <li><a href="../examples/dialog/layout.html" >Dialog with Layout</a></li>
158 <li><a href="../examples/dialog/msg-box.html" >Various Standard Message Boxes</a></li>
159 <li><a href="../examples/dialog/blog.html" >Simple Blog Post interface</a></li>
165 <li><b>Buttons</b><ul>
166 <li>Roo.<a href="../docs/symbols/Roo.Button.html" >Button</a></li>
167 <li>Roo.<a href="../docs/symbols/Roo.SplitButton.html" >SplitButton</a></li>
169 <li><b>Form / Entry</b><ul>
170 <li>Core Form / Layout<ul>
171 <li>Roo.form.<a href="../docs/symbols/Roo.form.Form.html" >Form</a></li>
172 <li>Roo.form.<a href="../docs/symbols/Roo.form.BasicForm.html" >BasicForm</a></li>
173 <li>Roo.form.<a href="../docs/symbols/Roo.form.Column.html" >Column</a></li>
174 <li>Roo.form.<a href="../docs/symbols/Roo.form.FieldSet.html" >FieldSet</a></li>
176 <li>Form Elements<ul>
177 <li>Roo.form.<a href="../docs/symbols/Roo.form.Hidden.html" >Hidden</a></li>
178 <li>Roo.form.<a href="../docs/symbols/Roo.form.TextField.html" >TextField</a></li>
179 <li>Roo.form.<a href="../docs/symbols/Roo.form.DateField.html" >DateField</a></li>
180 <li>Roo.form.<a href="../docs/symbols/Roo.form.NumberField.html" >NumberField</a> </li>
181 <li>Roo.form.<a href="../docs/symbols/Roo.form.TextArea.html" >TextArea</a></li>
182 <li>Roo.form.<a href="../docs/symbols/Roo.form.Checkbox.html" >Checkbox</a></li>
183 <li>Roo.form.<a href="../docs/symbols/Roo.form.Radio.html" >Radio</a></li>
184 <li>Roo.form.<a href="../docs/symbols/Roo.form.ComboBox.html" >ComboBox</a></li>
187 <li>Roo.form.<a href="../docs/symbols/Roo.form.HtmlEditor.html" >HtmlEditor</a> (broken on IE)</li>
188 <li>Roo.form.<a href="../docs/symbols/Roo.form.FCKeditor.html" >FCKeditor</a> embeded FCKeditor (slow but works)</li>
191 <li>Roo.form.<a href="../docs/symbols/Roo.form.Action.html" >Action</a> What happens when you load and save a form.</li>
192 <li>Roo.form.<a href="../docs/symbols/Roo.form.VTypes.html" >VTypes</a> Various types of Validation for form elements.</li>
193 <li>Roo.<a href="../docs/symbols/Roo.DatePicker.html" >DatePicker</a> Date Picker (not really a form element...)</li>
195 <li><b>Examples</b><ul>
196 <li><a href="../examples/form/dynamic.html" >Dynamic Forms</a></li>
197 <li><a href="../examples/form/combos.html" >Combox boxes</a></li>
198 <li><a href="../examples/form/htmledit.html" >HTML editor example</a></li>
199 <li><a href="../examples/form/custom.html" >Custom</a> - Autocomplete example - (Broken until we sort out a Json callback for trac)</li>
200 <li><a href="../examples/form/forum-search.html" >Search forum</a> - (Broken until we sort out a Json callback for trac)</li>
201 <li><a href="../examples/form/xml-form.html" >Form from/to xml</a> </li>
203 <li><a href="../examples/form/fck.html" >FCK editor example</a></li>
208 <li><a href="../docs/symbols/Roo.tree.TreePanel.html" >Roo.tree.TreePanel</a></li>
209 <li><a href="../docs/symbols/Roo.tree.TreeEditor.html" >Roo.tree.TreeEditor</a></li>
210 <li><a href="../docs/symbols/Roo.tree.AsyncTreeNode.html" >Roo.tree.AsyncTreeNode</a></li>
211 <li><a href="../docs/symbols/Roo.tree.TreeNode.html" >Roo.tree.TreeNode</a></li>
212 <li><a href="../docs/symbols/Roo.tree.TreeFilter.html" >Roo.tree.TreeFilter</a></li>
213 <li><a href="../docs/symbols/Roo.tree.TreeLoader.html" >Roo.tree.TreeLoader</a></li>
214 <li><a href="../docs/symbols/Roo.tree.TreeSorter.html" >Roo.tree.TreeSorter</a></li>
215 <li><a href="../docs/symbols/Roo.tree.DefaultSelectionModel.html" >Roo.tree.DefaultSelectionModel</a></li>
216 <li><a href="../docs/symbols/Roo.tree.MultiSelectionModel.html" >Roo.tree.MultiSelectionModel</a></li>
217 <li><b>Examples</b><ul>
218 <li><a href="../examples/tree/two-trees.html" >Two Trees</a> (need to rename it!)</li>
219 <li><a href="../examples/tree/reorder.html" >Re-orderable Trees</a></li>
220 <li><a href="../examples/tree/dependency.html" >The Roo Dependancy tree</a> (needs some css tidy up.)</li>
221 <li><a href="../examples/tree/organizer.html" >Organizer</a> (needs some css tidy up.)</li>
228 <li><a href="../docs/symbols/Roo.grid.GridPanel.html" >Roo.grid.GridPanel</a></li>
229 <li><a href="../docs/symbols/Roo.grid.CellSelectionModel.html" >Roo.grid.CellSelectionModel</a></li>
230 <li><a href="../docs/symbols/Roo.grid.RowSelectionModel.html" >Roo.grid.RowSelectionModel</a></li>
231 <li><a href="../docs/symbols/Roo.grid.ColumnModel.html" >Roo.grid.ColumnModel</a></li>
232 <li><a href="../docs/symbols/Roo.grid.EditorGrid.html" >Roo.grid.EditorGrid</a></li>
233 <li><a href="../docs/symbols/Roo.grid.Grid.html" >Roo.grid.Grid</a></li>
234 <li><a href="../docs/symbols/Roo.grid.GridEditor.html" >Roo.grid.GridEditor</a></li>
235 <li><a href="../docs/symbols/Roo.grid.GridView.html" >Roo.grid.GridView</a></li>
236 <li><a href="../docs/symbols/Roo.PagingToolbar.html" >Roo.PagingToolbar</a></li>
237 <li><b>Examples</b><ul>
238 <li><a href="../examples/grid/array-grid.html" >Grid from Array</a></li>
239 <li><a href="../examples/grid/custom-grid.html" >Property Grid</a> </li>
240 <li><a href="../examples/grid/from-markup.html" >Grid from HTML markup</a> IE: css broken</li>
241 <li><a href="../examples/grid/paging.html" >Paging Grid</a> FF: minor tidy up req, IE: Broken slightly when scrolling.</li>
242 <li><a href="../examples/grid/edit-grid.html" >Editable Grid</a> </li>
245 <li><b>Menu / Toolbars</b><ul>
246 <li><a href="../docs/symbols/Roo.menu.CheckItem.html" >Roo.menu.CheckItem</a></li>
247 <li><a href="../docs/symbols/Roo.menu.ColorItem.html" >Roo.menu.ColorItem</a></li>
248 <li><a href="../docs/symbols/Roo.menu.DateItem.html" >Roo.menu.DateItem</a></li>
249 <li><a href="../docs/symbols/Roo.menu.DateMenu.html" >Roo.menu.DateMenu</a></li>
250 <li><a href="../docs/symbols/Roo.menu.Menu.html" >Roo.menu.Menu</a></li>
251 <li><a href="../docs/symbols/Roo.menu.MenuMgr.html" >Roo.menu.MenuMgr</a></li>
252 <li><a href="../docs/symbols/Roo.menu.Separator.html" >Roo.menu.Separator</a></li>
253 <li><a href="../docs/symbols/Roo.menu.TextItem.html" >Roo.menu.TextItem</a></li>
254 <li><a href="../docs/symbols/Roo.Toolbar.html" >Roo.Toolbar</a></li>
255 <li><a href="../docs/symbols/Roo.Toolbar.Button.html" >Roo.Toolbar.Button</a></li>
256 <li><a href="../docs/symbols/Roo.Toolbar.Fill.html" >Roo.Toolbar.Fill</a></li>
257 <li><a href="../docs/symbols/Roo.Toolbar.Separator.html" >Roo.Toolbar.Separator</a></li>
258 <li><a href="../docs/symbols/Roo.Toolbar.Spacer.html" >Roo.Toolbar.Spacer</a></li>
259 <li><a href="../docs/symbols/Roo.Toolbar.SplitButton.html" >Roo.Toolbar.SplitButton</a></li>
260 <li><a href="../docs/symbols/Roo.Toolbar.TextItem.html" >Roo.Toolbar.TextItem</a></li>
261 <li><b>Examples</b><ul>
262 <li><a href="../examples/menu/menus.html" >Toolbar / Menus example</a> Minor css tweaking needed</li>
268 <li><b>View / Layers</b><ul>
269 <li><a href="../docs/symbols/Roo.JsonView.html" >Roo.JsonView</a></li>
270 <li><a href="../docs/symbols/Roo.Layer.html" >Roo.Layer</a></li>
271 <li><a href="../docs/symbols/Roo.View.html" >Roo.View</a></li>
272 <li><b>Examples</b><ul>
273 <li><a href="../examples/view/chooser.html" >Image Chooser</a> </li>
279 <li><b>Layout / Tabs</b><ul>
280 <li><a href="../docs/symbols/Roo.BasicLayoutRegion.html" >Roo.BasicLayoutRegion</a></li>
281 <li><a href="../docs/symbols/Roo.BorderRegion.html" >Roo.BorderRegion</a></li>
282 <li><a href="../docs/symbols/Roo.ContentPanel.html" >Roo.ContentPanel</a></li>
283 <li><a href="../docs/symbols/Roo.LayoutRegion.html" >Roo.LayoutRegion</a></li>
284 <li><a href="../docs/symbols/Roo.NestedLayoutPanel.html" >Roo.NestedLayoutPanel</a></li>
285 <li><a href="../docs/symbols/Roo.ReaderLayout.html" >Roo.ReaderLayout</a></li>
286 <li><a href="../docs/symbols/Roo.SplitBar.html" >Roo.SplitBar</a></li>
287 <li><a href="../docs/symbols/Roo.SplitLayoutRegion.html" >Roo.SplitLayoutRegion</a></li>
288 <li><a href="../docs/symbols/Roo.TabPanel.html" >Roo.TabPanel</a></li>
289 <li><a href="../docs/symbols/Roo.TabPanelItem.html" >Roo.TabPanelItem</a></li>
290 <li><b>Examples</b><ul>
291 <li><a href="../examples/layout/simple.html" >Simple Layout</a></li>
292 <li><a href="../examples/layout/nested.html" >Nested Layout</a> </li>
293 <li><a href="../examples/layout/complex.html" >Complex Layout</a> Broken - needs converting to Roo JS</li>
294 <li><a href="../examples/tabs/tabs.html" >Basic Tabs</a> (borders broken on tab boxes)</li>
295 <li><a href="../examples/tabs/tabs-adv.html" >Advanced Tabs</a> (dynamic adding of tabs)</li>