summaryrefslogtreecommitdiff
path: root/js/dojo-1.7.2/dojox/widget/README
blob: d211a8eeec0173f818049b4b55ea63292b510149 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
-------------------------------------------------------------------------------
dojox.widget Collection
-------------------------------------------------------------------------------
Version 1.0
Release date: 10/31/2007
-------------------------------------------------------------------------------
Project state:

[Calendar]		experimental
[CalendarFx]	experimental
[ColorPicker]	beta
[Dialog]		experimental
[DialogSimple]	beta
[FeedPortlet]	experimental
[FilePicker]	experimental
[FisheyeList]	experimental
[FisheyeLite]	beta
[Iterator]		experimental
[Loader]		experimental
[Pager]			experimental
[Portlet]		experimental
[PlaceholderMenuItem]	experimental
[Roller]		experimental
[RollingList]	experimental
[SortList]		experimental
[TitleGroup]	beta
[Toaster]		experimental
[Wizard]		experimental
[AnalogGauge]   experimental
[BarGauge]      experimental
[Standby]		experimental

-------------------------------------------------------------------------------
Credits:

[Calendar]		Shane O'Sullivan
[CalendarFx]	Shane O'Sullivan
[ColorPicker]	Peter Higgins (dante)
[Dialog]		Peter Higgins (dante)
[DialogSimple]	Peter Higgins (dante)
[FeedPortlet]	Shane O'Sullivan
[FilePicker]	Nathan Toone (toonetown)
[FisheyeList] 	Karl Tiedt (kteidt)
[FisheyeLite] 	Peter Higgins (dante)
[Iterator]		Alex Russell (slightlyoff)
[Loader]		Peter Higgins (dante)
[Pager]			Nikolai Onken (nonken), Peter Higgins (dante);
[PlaceholderMenuItem]	Nathan Toone (toonetown)
[Portlet]		Shane O'Sullivan
[Roller]		Peter Higgins (dante)
[RollingList] 	Nathan Toone (toonetown)
[SortList]		Peter Higgins (dante)
[TitleGroup]	Peter Higgins (dante)
[Toaster]		Adam Peller (peller)
[Wizard]		Peter Higgins (dante)
[AnalogGauge]	Benjamin Schell (bmschell) CCLA
[BarGauge]		Benjamin Schell (bmschell) CCLA 
[Standby]		Jared Jurkiewicz (jaredj) CCLA 
[UpgradeBar]	Mike Wilcox (mwilcox), Revin Guillen

-------------------------------------------------------------------------------
Project description

	This is a collection of standalone widgets for use in
	your website.  Each individual widget is independent
	of the others.
	
-------------------------------------------------------------------------------
Dependencies:

	Each widget has it's own requirements and dependencies.
	Most inherit from dijit base-classes such as dijit._Widget,
	dijit._Templated, etc ... So we will assume the availablility
	of dojo (core), and dijit packages.
	
	Each individual component stores resources in a folder that shares 
	a name with the Widget. For instance:
	
	the Dialog lives in 
	dojox/widget/Dialog.js ... 

	and the folder:
	dojox/widget/Dialog/ 	contains a 'Dialog.css', the required 
	styles for that particular widget. All required templates and 
	images reside in the folder. 
	
	This differs slightly from the rest of DojoX in that each other
	project uses a shared resources/ folder in the project folder,
	though uses the same naming convention for stylesheets and templates.

	eg:
	dojox/layout/resources/ExpandoPane.css
	dojox.layout.ExpandoPane
	
-------------------------------------------------------------------------------
Documentation

	Please refer to the API-tool, or in-line documentation. All of these
	widgets are of varying use, quality, and documentation completion.
	
-------------------------------------------------------------------------------
Installation instructions

	These are standalone Widgets, so putting the [widget].js file 
	in your dojox/widget folder, and copying any files in the
	/dojox/widget/[widget]/ folder as supplements/templates/etc
	should be all you need to do.

	eg: FisheyeList:
	/dojox/widget/FisheyeList.js
	/dojox/widget/FisheyeList/FisheyeList.css

	should be all you need to use the Fisheye widget.	
	
	you can safely import the whole widget project into your 
	dojox/ root directory from the following SVN url:

	http://svn.dojotoolkit.org/src/dojox/trunk/widget

-------------------------------------------------------------------------------
Other Notes (Brief widget list):

    * ColorPicker - An HSV ColorPicker intended to be a drop down

	* Calendar - An extension on the dijit._Calendar providing a different UI
	* CalendarFx - additional mixable FX for transitions in dojox.widget.Calendar

	* Dialog - An extended version of dijit.Dialog with man options and transition.
	
	* DialogSimple - A simple Dijit Dialog providing `dojox.layout.ContentPane` integration

	* FilePicker - a widget for browsing server-side file systems (can use
		dojox.data.FileStore as backend store)

	* FisheyeList - the classic FishEye Picker (abandoned)

	* FisheyeLite - A partial replacement for the FisheyeList - serious performance
		gains, and entirely more extensible in that it simply animates defined
		properties, relying on the natural styling as a foundation.

	* Iterator - Basic array and data store iterator class
	
	* Loader - an experimental Class that listens to XHR 
		connections in the background, and displays 
		a loading indicator. Loader will be removed in 1.3, and is (abandoned).

	* PlaceholderMenuItem - a menu item that can be used to inject other menu
		items at a given location. Extends dijit.Menu directly. 

	* Roller - A component to show many lines of text in a single area, rotating
		through the options available. Also provides RollerSlide, an extension
		to the stock fading roller to add a slide animation to the transition.

	* RollingList - A component of the FilePicker widget

	* SortList - a degradable UL with a fixed header, scrolling,
		and sorting. Can be the direct descendant of a
		LayoutContainer and will size to fit.

	* TitleGroup - A container offering variable height TitlePane access, though
		behaves like an AccordionContainer 

	* Toaster - a messaging system to display unobtrusive 
		alerts on screen.

	* Wizard - a StackContainer with built-in navigation to
		ease in the creation of 'step-based' content.
		Requires dojo >= 1.1 
                
	* AnalogGauge - an analog style customizable gauge for displaying values in an
		animated fashion and with multiple indicators.  Supports easings for 
		indicator animations, transparent overlays, etc.  Very flexible.
		Requires dojo >= 1.3
	
	* BarGauge - a bar style gauge for displaying values in an animated fashion 
		and with multiple indicators.  Supports easings for indicator animations,
		etc.  Very flexible.
		Requires dojo >= 1.3

	* Standby - a 'blocker' style widget to overlay a translucent div + image over a DOM node/widget 
		to indicate busy. Overlay color, image, and alt text can all be customized.
		Requires dojo >= 1.3

	* UpgradeBar - Displays the "yellow bar" at the top of a page to indicate the user
 		needs to upgrade their browser or a plugin
		Requires dojo >= 1.3