source: Dev/branches/rest-dojo-ui/client/dojox/layout/README @ 256

Last change on this file since 256 was 256, checked in by hendrikvanantwerpen, 13 years ago

Reworked project structure based on REST interaction and Dojo library. As
soon as this is stable, the old jQueryUI branch can be removed (it's
kept for reference).

File size: 4.5 KB
Line 
1-------------------------------------------------------------------------------
2dojox.layout Experimental and Extended Layout Widgets
3-------------------------------------------------------------------------------
4Version 1.0
5Release date: 10/31/2007
6-------------------------------------------------------------------------------
7Project state:
8
9[BorderContainer] deprecated, use dijit.layout.BorderContainer
10[ContentPane]   beta
11[DragPane]      experimental
12[ExpandoPane] experimental
13[FloatingPane] sub-experimental
14[GridContainer] experimental
15[RadioGroup] experimental
16[RadioGroupFade/Slide] experimental
17[ResizeHandle] experimental
18[RotatorContainer] beta
19[ScrollPane] experimental
20[TableContainer] experimental
21
22-------------------------------------------------------------------------------
23Credits
24
25[BorderContainer] Adam Peller (peller)
26[ContentPane]   Fredrik Johansson (mumme)
27[DragPane]      Peter Higgins (dante)
28[ExpandoPane] Peter Higgins (dante)
29[FloatingPane] Peter Higgins (dante)
30[GridContainer/GridContainerLite] Erwan Morvillez (emorvillez), Jeff Cunat (jfcunat), Guillaume Mouricou (gmouricou), Peter Higgins (dante)
31[RadioGroup/Fade/Slide] Peter Higgins (dante)
32[ResizeHandle] Peter Higgins (dante)
33[RotatorContainer] Chris Barber (cb1)
34[ScrollPane] Peter Higgins (dante), Shane O'Sullivan (sos)
35[TableContainer] Shane O'Sullivan (sos)
36
37-------------------------------------------------------------------------------
38Project description
39
40        placeholder for dijit.layout extensions. Currently only:
41
42        dojo.layout.BorderContainer - deprecated, simple replacement at dijit.layout.BorderContainer
43
44        dojox.layout.ContentPane - an extension on dijit ContentPane.
45        Supports inline scripts, inline styles, relative path adjustments
46        and having a table tag as domNode.
47
48        dojox.layout.DragPane - an experimental start of a simple Dragable pane
49        (drag larger content around inside of a sized pane) Does not support borderContainer
50        LayoutContainer resizing yet.
51
52        dojox.layout.ExpandoPane - Intended only as a child of BorderContainer, provides an
53        experimental layout region (top/left/right/bottom) that collapses when toggled, hiding
54        the layout children contained within.
55       
56        dojox.layout.FloatingPane - an extension on TitlePane for drag/drop
57        operation, "docking" [minimize/maximize], and resizing. HIGHLY experimental.
58       
59        dojox.layout.GridContainer - displays children in a definable grid-layout,
60        allowing children to optionally be repositioned with DnD
61
62        dojox.layout.RadioGroup - a stack container with sliding or fading transitions
63        (and an internal button set to mimic a tab container, but fires on hover)
64                - RadioGroupFade - fade transitions
65                - RadioGroupSlide - slide transitions
66
67        dojox.layout.ResizeHandle - resize handle to attach to a domNode.
68        works well on normal domNodes, but will require adding a resizeTo(w,h)
69        method to any widget you wish to use it on. [experimental]
70
71        dojox.layout.RotatorContainer - similar to a RadioGroup, but provides advanced button's and
72        control.
73
74        dojox.layout.ScrollPane - a dynamically scrolling pane. Adjusts naturally sized content
75        to a "viewport" and scrolls based on relative mouse position.
76       
77        dojox.layout.TableContainer - A container widget that lays out child widgets using a
78        Table element. It can create labels for each widget, placed either above or
79        beside the widgets.
80       
81-------------------------------------------------------------------------------
82Dependencies
83
84        require Dojo Core, Dojo Base (fx), and Dijit
85
86-------------------------------------------------------------------------------
87Installation:
88
89        checkout:
90
91        http://svn.dojotoolkit.org/src/dojox/trunk/layout/
92        http://svn.dojotoolkit.org/src/dijit/trunk/
93
94        and require via:
95                dojo.require("dojox.layout.FloatingPane");
96        or:
97                dojo.require("dojox.layout.ContentPane");
98        etc ...
99
100        Each component has a required CSS File with a similar name, contained within the
101        /resources folder. Include that file in your page. For instance, if using
102        the dojox.layout.ExpandoPane:
103       
104        <link rel="stylesheet" href="dojo-tree/dojox/layout/resources/ExpandoPane.css" />
105
106-------------------------------------------------------------------------------
107Basic Usage:
108
109        <div dojoType="dojox.layout.FloatingPane" title="my title">
110                Content To be Floated
111        </div>
112
113        <div dojoType="dojox.layout.ContentPane"
114                 adjustPaths="true"
115                 renderStyles="true"
116                 executeScripts="true"
117                 href="my/page/containing/scripts/and/styles/in/a/sub/folder.html"
118        >
119                Initial content, will be replace by href.
120                paths in folder.html will be adjusted to match this page
121        </div>
Note: See TracBrowser for help on using the repository browser.