DojoX

DojoX is an area for development of extensions to the Dojo toolkit. It is a repository for more stable and mature extensions and also acts as an incubator for experimental code, a testbed for additions to the main toolkit. Unlike Dojo and Dijit, DojoX is managed by subprojects, each of which has at least one module, a sponsor and a mission statement.

• About DojoX

These sections cover the available projects shipped with the Dojo Toolkit:

• dojox.analytics

  An analytic and client monitoring system

  • dojox.analytics.Urchin

• dojox.app

  Implements the application framework using dojox.mvc for web application on desktop and mobile platforms

• dojox.atom

  Implements the Atom Syndication Format and Atom Publishing Protocol

  • dojox.atom.io.model

    A JavaScript model of an ATOM feed

  • dojox.atom.io.Connection

    A IO class for performing APP (ATOM Publishing Protocol) styled IO actions with a server

• dojox.av

  Brings audio and video capabilities to the Open Web

  • dojox.av.FLAudio

    Provides the ability of implementing MP3 sounds into your dojo applications

  • dojox.av.FLVideo

    Provides the ability to play Flash movie files (FLVs) within the dojo environment

  • dojox.av.widget

    Provides base player control widgets for building a media player

• dojox.charting

  Amazing charting library

• dojox.collections

  Offers methods to handle common collections, like ArrayLists or Dictionaries

• dojox.color

  Extends dojo.color/dojo.Color and adds advanced color model/matching functionality

  • dojox.color.Palette

    A color palette generator and handler (used extensively in dojox.charting)

• dojox.cometd

  A cometd client written in Dojo

• dojox.data

  Additional data stores and data store helpers

  • dojox.data.AndOrReadStore

    A clone of dojo.data.ItemFileReadStore, which supports more complex queries than the simple AND format property matching

  • dojox.data.AndOrWriteStore

    A clone of dojo.data.ItemFileWriteStore, which supports more complex queries than the simple AND format property matching

  • dojox.data.AtomReadStore

    A store designed to provide read-only access to Atom XML documents

  • dojox.data.ClientFilter

    An abstract data store module for adding updateable result set functionality to an existing data store class

  • dojox.data.CouchDBRestStore

    A datastore for connecting to the open source document-oriented database Apache CouchDB

  • dojox.data.CssClassStore

    A read interface based on the dojox.data.CssRuleStore

  • dojox.data.CssRuleStore

    A read interface to the CSS rules loaded in the current page

  • dojox.data.CsvStore

    A read interface that works with CSV formatted data files

  • dojox.data.FileStore

    A lightweight data store implementation for accessing details about a remote FileSystem

  • dojox.data.FlickrRestStore

    Provides access to the Flickr photo sharing site’s REST API

  • dojox.data.FlickrStore

    A wrapper to the public photo feed of the Flickr service

  • dojox.data.GoogleFeedStore

    A Google AJAX API powered data store for retrieving RSS and Atom feeds from Google

  • dojox.data.GoogleSearchStore

    Several data stores to interface Google’s AJAX search services:

    • dojox.data.GoogleWebSearchStore

      A data store for retrieving search results from Google

    • dojox.data.GoogleBlogSearchStore

      A data store for retrieving search results from Google Blogs

    • dojox.data.GoogleLocalSearchStore

      A data store for retrieving search results from Google Location Search

    • dojox.data.GoogleVideoSearchStore

      A data store for retrieving search results from Google Video

    • dojox.data.GoogleNewsSearchStore

      A data store for retrieving search results from Google News

    • dojox.data.GoogleBookSearchStore

      A data store for retrieving search results from Google Book

    • dojox.data.GoogleImageSearchStore

      A data store for retrieving search results from Google Image

  • dojox.data.HtmlStore

    An enhanced replacement for dojox.data.HtmlTableStore to work with HTML tables, lists, and collections of DIV and SPAN tags.

  • dojox.data.HtmlTableStore (deprecated)

    A read interface to work with HTML tables

  • dojox.data.jsonPathStore

    A local (in memory) store which can attach a dojo.data interface to each javascript object and uses jsonPath as the query language

  • dojox.data.JsonRestStore

    A lightweight data store implementation of a RESTful client

  • dojox.data.KeyValueStore

    An interface for reading property style files (key/value pairs)

  • dojox.data.OpmlStore

    A read-only store to work with Opml formatted XML files

  • dojox.data.PersevereStore

    An extension of dojox.data.JsonRestStore to handle Persevere’s special features

  • dojox.data.PicasaStore

    A data store interface to one of the basic services of the Picasa service, the public photo feed

  • dojox.data.QueryReadStore

    A read-only store, which makes a request to the server for each sorting or query in order to work with big datasets

  • dojox.data.S3Store

    An extension of dojox.data.JsonRestStore to handle Amazon’s S3 service using JSON data

  • dojox.data.ServiceStore

    ServiceStore and it’s subclasses are a generalized dojo.data implementation for any webservice

  • dojox.data.SnapLogicStore

    A data store interface to use the SnapLogic framework

  • dojox.data.WikipediaStore

    An extension of dojox.data.ServiceStore to use Wikipedia’s search service

  • dojox.data.XmlStore

    A read and write interface to basic XML data

  • dojox.data.dom

    A set of DOM manipulation functions

• dojox.date

  A collection of date-related enhancements and utilities, including national calendars.

  • dojox.date.buddhist

    A date-like class representing the Thai buddhist calendar

  • dojox.date.hebrew

    A date-like class representing the Hebrew calendar

  • dojox.date.islamic

    A date-like class representing the Islamic or Hijri calendar

• dojox.drawing

  Vector graphics drawing editor

• dojox.dtl

  Django Template Language implementation

• dojox.editor

  Extensions for dijit.Editor

• dojox.embed

  Base code for embedding external objects like Flash, Quicktime

• dojox.encoding

  All sorts of string encoding algorithms, including compression, crypto and more.

• dojox.flash

  Utilities to embed and communicate with Flash-based objects

• dojox.form

  Additional form-related widgets beyond dijit.form functionality

  • dojox.form.BusyButton

    A new Button with progress indicator built in, for indicating processing after you press the button

  • dojox.form.CheckedMultiSelect

    A multi-select widget (similar to html select with multiple=true) that uses check boxes

  • dojox.form.DateTextBox

    description?

  • dojox.form.DropDownSelect

    A styleable drop down select box (similar to html select element). Moved to dijit.form.Select. See also dijit.form.Select

  • dojox.form.DropDownStack

    A widget for enabling/disabling parts of a form based on a selection

  • dojox.form.FileInput (covers base, Auto, and Blind)

    A series of experimental Vanilla input type=”file” widgets for uploading files. See also dojox.form.Uploader

  • dojox.form.FilePickerTextBox

    A dijit._FormWidget that adds a dojox.widget.FilePicker to a text box as a dropdown

  • dojox.form.FileUploader

    Deprecated old multi-file uploader that shows progress as the files are uploading. Use dojox.form.Uploader instead.

  • dojox.form.ListInput

    The ListInput widget allows you to create a list of elements.

  • dojox.form.manager

    A package to manage complex event-driven dynamic forms

  • dojox.form.Manager (widget)

    A widget that uses dojox.form.manager to handle dynamic forms

  • dojox.form.MultiComboBox

    Extension to ComboBox to allow “tag” style input using a datastore using a delimiter.

  • dojox.form.PasswordValidator

    A widget that simplifies the “Old/New/Verify” password construct used on many web pages

  • dojox.form.RadioStack

    A widget for enabling/disabling parts of a form based on a selection

  • dojox.form.RangeSlider

    A widget that allows a range of values to be selected along a scale

  • dojox.form.Rating

    A widget that allows users to rate items

  • dojox.form.TimeSpinner

    This widget is the same as dijit.form.NumberSpinner, but for the time component of a date object instead

  • dojox.form.Uploader

    A widget that adds functionality to a standard HTML file input. It hides the actual uploader and substitutes a dijit.form.Button.

• dojox.fx

  Extension animations to the core dojo FX project

  • dojox.fx.crossFade

    Crossfade two nodes easily

  • dojox.fx.highlight

    Animates the background color of a node, and returns it to the color it was

  • dojox.fx.sizeTo

    Size a node about it’s center to a new width/height

  • dojox.fx.slideBy

    Slide a node by a t,l offset

  • dojox.fx.style

    Module to provide CSS animations

  • dojox.fx.scroll

    Module to provide scroll-related FX

  • dojox.fx.wipeTo

• dojox.gantt

  A project and resource management tool

• dojox.gauges

  A collection of gauge widgets used to display numerical data

  • dojox.gauges.AnalogGauge

    A circular gauge with a variety of indicators, used to display numerical data

  • dojox.gauges.BarGauge

    A horizontal bar gauge with a few indicators, used to display numerical data

  • dojox.gauges.GlossyCircularGauge

    A circular gauge.

  • dojox.gauges.GlossySemiCircularGauge

    A semi circular gauge.

  • dojox.gauges.GlossyHorizontalGauge

    An horizontal gauge.

• dojox.geo

  A module to display geographical content

• dojox.gesture

  Provides gesture events that can run well across a wide range of devices

• dojox.gfx

  Cross-browser vector graphics API

• dojox.gfx3d

  A 3d API for dojox.gfx

• dojox.grid

  Dojo Toolkit’s Grid Widgets

  • dojox.grid.DataGrid

    A visual grid/table much like a spreadsheet

  • dojox.grid.EnhancedGrid

    An enhanced version of the base grid, which extends it in numerous useful ways

  • dojox.grid.TreeGrid

    A grid with support for collapsible rows and model-based (dijit.tree.ForestStoreModel) structure

  • dojox.grid.LazyTreeGrid

    An extended version of TreeGrid that can lazy load and virtual scroll nested levels of huge children rows.

  • the old dojox.grid.Grid

    This old version is only available for compatible reasons

  • Grid Plugin API

• dojox.help

• dojox.highlight

  A client-side syntax highlighting engine

• dojox.html

  Additional HTML helper functions

  • dojox.html.format

    A package which offers additional HTML helper functions for formatting HTML text

  • dojox.html.set

    A generic content setter, including adding new stylesheets and evaluating scripts (was part of ContentPane loaders, now separated for generic usage)

  • dojox.html.metrics

    Translate CSS values to pixel values, calculate scrollbar sizes and font resizes

  • dojox.html.styles

    Insert, remove and toggle CSS rules as well as search document for style sheets

• dojox.image

  A collection of image-related widgets

  • dojox.image.Badge

    Attach images or background images, and let them loop

  • dojox.image.FlickrBadge

    An extension on dojox.image.Badge, using Flickr as a data provider

  • dojox.image.Gallery

    A combination of a SlideShow and ThumbnailPicker

  • dojox.image.Lightbox

    A widget which shows a single image (or groups of images) in a Dialog

  • dojox.image.LightboxNano

    Similar to a Lightbox, though much lighter weight, and animated to center from position in page.

  • dojox.image.Magnifier

    A dojox.gfx-based version of the MagnifierLite widget

  • dojox.image.MagnifierLite

    A simple hover behavior for images, showing a zoomed version of a size image

  • dojox.image.SlideShow

    A slideshow of images

  • dojox.image.ThumbnailPicker

    A dojo.data-powered ThumbnailPicker

• dojox.io

  Extensions to the Core dojo.io transports

• dojox.json

  DojoX JSON Modules

  • dojox.json.query

    A comprehensive object data query tool

  • dojox.json.schema

    An object validation tool based on JSON Schema

  • dojox.json.ref

    JSON Referencing capable serializer and deserializer

• dojox.jsonPath

  A query system for JavaScript objects

• dojox.lang

  JavaScript language extensions for supporting AOP, FP and other language constructs

  • dojox.lang.aspect

    Provides a framework for aspect-oriented programming.

  • dojox.lang.async

    Provides helpers for event-driven programming.

  • dojox.lang.docs

    Provides schemas on Dojo’s classes from the API documentation

  • dojox.lang.functional

    Functional language constructs, including currying and lambda

  • dojox.lang.observable

    Provides construction of objects such that property access and modification can be controlled, i.e. provides a form of getters/setters

  • dojox.lang.oo

    Provides mixers to support traits and mixins for object-oriented programming.

  • dojox.lang.typed

    Provides type checking for JavaScript classes, enforcing types on properties and method parameters using JSON Schema definitions.

• dojox.layout

  Experimental and additional extensions to Dijit Layout Widgets

  • dojox.layout.ContentPane

    An extension to dijit.layout.ContentPane providing script execution, among other things

  • dojox.layout.DragPane

    Provides drag-based scrolling for divs with overflow

  • dojox.layout.ExpandoPane

    A self-collapsing widget for use in a BorderContainer

  • dojox.layout.FloatingPane

    An experimental floating window

  • dojox.layout.GridContainer

    A panel-like layout mechanism, allowing Drag and Drop between regions

  • dojox.layout.RadioGroup

    A variety of StackContainer enhancements providing animated transitions

  • dojox.layout.ResizeHandle

    A small widget to provide resizing of a parent node

  • dojox.layout.RotatorContainer

    An extended StackContainer suited for presentational purposes

  • dojox.layout.ScrollPane

    An interesting UI, scrolling an overflowed div based on mouse position, either vertical or horizontal

  • dojox.layout.TableContainer

    A simple layout widget that lays out its child widgets using a Table element.

  • dojox.layout.ToggleSplitter

    A custom Splitter for use in a BorderContainer, providing a lightweight way to collapse the associated child

• dojox.math

  A collection of various advanced math functions

• dojox.mdnd

  Experimental coordinates based moveable drag and drop. Use stable dojo.dnd <dojo/dnd> instead.

• dojox.mobile

  A collection of utilities to get native look&feel on web apps for iPhone/iPad/Android

• dojox.mvc

  A collection of features for enabling Model-View-Controller (MVC) patterns in Dojo

• dojox.NodeList - Additional extensions to dojo.NodeList

• dojox.off

• dojox.presentation

• dojox.resources

• dojox.robot

• dojox.rpc

  Extended classes to communicate via Remote Procedure Calls (RPC) with Backend Servers

  • dojox.rpc.SMDLibrary

  • dojox.rpc.Client

  • dojox.rpc.JsonRest

  • dojox.rpc.JsonRPC

  • dojox.rpc.LocalStorageRest

  • dojox.rpc.OfflineRest

    Provides automatic offline capabilities to the JsonRest/JsonRestStore modules

  • dojox.rpc.ProxiedPath

  • dojox.rpc.Rest

    Provides a HTTP REST service with full range REST verbs include GET, PUT, POST and DELETE

  • dojox.rpc.Service

    The foundation of most dojox.RPC transportation

• dojox.secure

• dojox.sketch

• dojox.sql

  objects to support Dojo Offline (dojox.off) DEPRECATED

• dojox.storage

  Objects for mass storage within the browser

• dojox.string

  A collection of various objects for advanced string manipulation, including a Builder and a tokenizer

• dojox.testing

• dojox.timing

  A set of objects to perform advanced time-based tasks, including a basic Timer

• dojox.uuid

  Universally Unique Identifier (UUID) implementations, including an implementation of UUID 2

• dojox.validate

  Additional input validation methods

• dojox.widget

  A collection of un-categorized widgets, or code not requiring its own package

  • dojox.widget.AnalogGauge

    A circular gauge with a variety of indicators, used to display numerical data

  • dojox.widget.AutoRotator

    A rotator that automatically transitions between child nodes

  • dojox.widget.BarGauge

    A horizontal bar gauge with a few indicators, used to display numerical data

  • dojox.widget.Calendar

    An extended dijit._Calendar

  • dojox.widget.CalendarFx

    An extended dijit._Calendar with FX

  • dojox.widget.ColorPicker

    A HSV Color Picker, similar to PhotoShop

  • dojox.widget.Dialog

    An extension to dijit.Dialog which provides additional sizing options, animations, and styling

  • dojox.widget.DocTester

    A widget to run DocTests inside an HTML page

  • dojox.widget.FeedPortlet

    An enhanced Portlet which can load both remote and local Atom and RSS feeds, displaying them as a list

  • dojox.widget.FilePicker

    A specialized version of RollingList that handles file information

  • dojox.widget.FisheyeList

    A OSX-style Fisheye Menu

  • dojox.widget.FisheyeLite

    A more robust Fisheye Widget, which fish-eyes’ any CSS property

  • dojox.widget.Iterator

    A basic array and data store iterator class

  • dojox.widget.Loader

    A small experimental Ajax Activity indicator (deprecated, will be moved to dojo-c)

  • dojox.widget.Pager

    A dojo.data powered Pager Widget, displaying a few items in a horizontal or vertical UI

  • dojox.widget.PlaceholderMenuItem

    A menu item that can be used as a placeholder.

  • dojox.widget.Portlet

    An enhanced TitlePane designed to be used with the dojox.layout.GridContainer

  • dojox.widget.Roller

    An unobtrusive “roller”, displaying one message from a list in a loop

  • dojox.widget.RollingList

    A rolling list that can be tied to a data store with children

  • dojox.widget.Rotator

    A widget for rotating through child nodes using transitions

  • dojox.widget.SortList

    A small sortable unordered-list

  • dojox.widget.Standby

    A small widget that can be used to mark sections of a page as busy, processing, unavailable, etc.

  • dojox.widget.Toaster

    A message display system, showing warnings, errors and other messages unobtrusively

  • dojox.widget.UpgradeBar

    Shows the “yellow bar” at the top of the screen when the user is to be notified that they should upgrade their browser or a plugin.

  • dojox.widget.Wizard

    A simple widget providing a step-by-step wizard like UI

• dojox.wire

  Declarative data binding and action tags for simplified MVC

• dojox.xml

  XML utilities

• dojox.xmpp

  XMPP (Jabber Client) Service implementation in pure javascript

Table of Contents

• DojoX