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