root / trunk / web / dojo / dojox / widget / README
History | View | Annotate | Download (6.23 KB)
1 | 9 | andrej.cim | ------------------------------------------------------------------------------- |
---|---|---|---|
2 | dojox.widget Collection |
||
3 | ------------------------------------------------------------------------------- |
||
4 | Version 1.0 |
||
5 | Release date: 10/31/2007 |
||
6 | ------------------------------------------------------------------------------- |
||
7 | Project state: |
||
8 | |||
9 | [Calendar] experimental |
||
10 | [CalendarFx] experimental |
||
11 | [ColorPicker] beta |
||
12 | [Dialog] experimental |
||
13 | [FeedPortlet] experimental |
||
14 | [FilePicker] experimental |
||
15 | [FisheyeList] experimental |
||
16 | [FisheyeLite] beta |
||
17 | [Iterator] experimental |
||
18 | [Loader] experimental |
||
19 | [Pager] experimental |
||
20 | [Portlet] experimental |
||
21 | [PlaceholderMenuItem] experimental |
||
22 | [Roller] experimental |
||
23 | [RollingList] experimental |
||
24 | [SortList] experimental |
||
25 | [Toaster] experimental |
||
26 | [Wizard] experimental |
||
27 | [AnalogGauge] experimental |
||
28 | [BarGauge] experimental |
||
29 | [Standby] experimental |
||
30 | ------------------------------------------------------------------------------- |
||
31 | Credits: |
||
32 | |||
33 | [Calendar] Shane O'Sullivan |
||
34 | [CalendarFx] Shane O'Sullivan |
||
35 | [ColorPicker] Peter Higgins (dante) |
||
36 | [Dialog] Peter Higgins (dante) |
||
37 | [FeedPortlet] Shane O'Sullivan |
||
38 | [FilePicker] Nathan Toone (toonetown) |
||
39 | [FisheyeList] Karl Tiedt (kteidt) |
||
40 | [FisheyeLite] Peter Higgins (dante) |
||
41 | [Iterator] Alex Russell (slightlyoff) |
||
42 | [Loader] Peter Higgins (dante) |
||
43 | [Pager] Nikolai Onken (nonken), Peter Higgins (dante); |
||
44 | [PlaceholderMenuItem] Nathan Toone (toonetown) |
||
45 | [Portlet] Shane O'Sullivan |
||
46 | [Roller] Peter Higgins (dante) |
||
47 | [RollingList] Nathan Toone (toonetown) |
||
48 | [SortList] Peter Higgins (dante) |
||
49 | [Toaster] Adam Peller (peller) |
||
50 | [Wizard] Peter Higgins (dante) |
||
51 | [AnalogGauge] Benjamin Schell (bmschell) CCLA |
||
52 | [BarGauge] Benjamin Schell (bmschell) CCLA |
||
53 | [Standby] Jared Jurkiewicz (jaredj) CCLA |
||
54 | [UpgradeBar] Mike Wilcox (mwilcox), Revin Guillen |
||
55 | |||
56 | ------------------------------------------------------------------------------- |
||
57 | Project description |
||
58 | |||
59 | This is a collection of standalone widgets for use in |
||
60 | your website. Each individual widget is independent |
||
61 | of the others. |
||
62 | |||
63 | ------------------------------------------------------------------------------- |
||
64 | Dependencies: |
||
65 | |||
66 | Each widget has it's own requirements and dependencies. |
||
67 | Most inherit from dijit base-classes such as dijit._Widget, |
||
68 | dijit._Templated, etc ... So we will assume the availablility |
||
69 | of dojo (core), and dijit packages. |
||
70 | |||
71 | Each individual component stores resources in a folder that shares |
||
72 | a name with the Widget. For instance: |
||
73 | |||
74 | the Dialog lives in |
||
75 | dojox/widget/Dialog.js ... |
||
76 | |||
77 | and the folder: |
||
78 | dojox/widget/Dialog/ contains a 'Dialog.css', the required |
||
79 | styles for that particular widget. All required templates and |
||
80 | images reside in the folder. |
||
81 | |||
82 | This differs slightly from the rest of DojoX in that each other |
||
83 | project uses a shared resources/ folder in the project folder, |
||
84 | though uses the same naming convention for stylesheets and templates. |
||
85 | |||
86 | eg: |
||
87 | dojox/layout/resources/ExpandoPane.css |
||
88 | dojox.layout.ExpandoPane |
||
89 | |||
90 | ------------------------------------------------------------------------------- |
||
91 | Documentation |
||
92 | |||
93 | Please refer to the API-tool, or in-line documentation. All of these |
||
94 | widgets are of varying use, quality, and documentation completion. |
||
95 | |||
96 | ------------------------------------------------------------------------------- |
||
97 | Installation instructions |
||
98 | |||
99 | These are standalone Widgets, so putting the [widget].js file |
||
100 | in your dojox/widget folder, and copying any files in the |
||
101 | /dojox/widget/[widget]/ folder as supplements/templates/etc |
||
102 | should be all you need to do. |
||
103 | |||
104 | eg: FisheyeList: |
||
105 | /dojox/widget/FisheyeList.js |
||
106 | /dojox/widget/FisheyeList/FisheyeList.css |
||
107 | |||
108 | should be all you need to use the Fisheye widget. |
||
109 | |||
110 | you can safely import the whole widget project into your |
||
111 | dojox/ root directory from the following SVN url: |
||
112 | |||
113 | http://svn.dojotoolkit.org/src/dojox/trunk/widget |
||
114 | |||
115 | ------------------------------------------------------------------------------- |
||
116 | Other Notes (Brief widget list): |
||
117 | |||
118 | * ColorPicker - An HSV ColorPicker intended to be a drop down |
||
119 | |||
120 | * Calendar - An extension on the dijit._Calendar providing a different UI |
||
121 | * CalendarFx - additional mixable FX for transitions in dojox.widget.Calendar |
||
122 | |||
123 | * Dialog - An extended version of dijit.Dialog with man options and transition. |
||
124 | |||
125 | * FilePicker - a widget for browsing server-side file systems (can use |
||
126 | dojox.data.FileStore as backend store) |
||
127 | |||
128 | * FisheyeList - the classic FishEye Picker (abandoned) |
||
129 | |||
130 | * FisheyeLite - A partial replacement for the FisheyeList - serious performance |
||
131 | gains, and entirely more extensible in that it simply animates defined |
||
132 | properties, relying on the natural styling as a foundation. |
||
133 | |||
134 | * Iterator - Basic array and data store iterator class |
||
135 | |||
136 | * Loader - an experimental Class that listens to XHR |
||
137 | connections in the background, and displays |
||
138 | a loading indicator. Loader will be removed in 1.3, and is (abandoned). |
||
139 | |||
140 | * PlaceholderMenuItem - a menu item that can be used to inject other menu |
||
141 | items at a given location. Extends dijit.Menu directly. |
||
142 | |||
143 | * Roller - A component to show many lines of text in a single area, rotating |
||
144 | through the options available. Also provides RollerSlide, an extension |
||
145 | to the stock fading roller to add a slide animation to the transition. |
||
146 | |||
147 | * RollingList - A component of the FilePicker widget |
||
148 | |||
149 | * SortList - a degradable UL with a fixed header, scrolling, |
||
150 | and sorting. Can be the direct descendant of a |
||
151 | LayoutContainer and will size to fit. |
||
152 | |||
153 | * Toaster - a messaging system to display unobtrusive |
||
154 | alerts on screen. |
||
155 | |||
156 | * Wizard - a StackContainer with built-in navigation to |
||
157 | ease in the creation of 'step-based' content. |
||
158 | Requires dojo >= 1.1 |
||
159 | |||
160 | * AnalogGauge - an analog style customizable gauge for displaying values in an |
||
161 | animated fashion and with multiple indicators. Supports easings for |
||
162 | indicator animations, transparent overlays, etc. Very flexible. |
||
163 | Requires dojo >= 1.3 |
||
164 | |||
165 | * BarGauge - a bar style gauge for displaying values in an animated fashion |
||
166 | and with multiple indicators. Supports easings for indicator animations, |
||
167 | etc. Very flexible. |
||
168 | Requires dojo >= 1.3 |
||
169 | |||
170 | * Standby - a 'blocker' style widget to overlay a translucent div + image over a DOM node/widget to indicate busy. |
||
171 | Overlay color, image, and alt text can all be customized. |
||
172 | Requires dojo >= 1.3 |
||
173 | |||
174 | * UpgradeBar - Displays the "yellow bar" at the top of a page to indicate the user |
||
175 | needs to upgrade their browser or a plugin |
||
176 | Requires dojo >= 1.3 |