Constructordojox.presentation.Deck

dojo.require("dojox.presentation._base");
defined in dojox/presentation/_base.js

dojox.presentation class basic powerpoint esque engine for handling transitons and control in a page-by-page and part-by-part way FIXME: parsing part(s)/widget(s) in href="" Slides not working TODO: make auto actions progress. FIXME: Safari keydown/press/up listener not working.

Usage

function ()
parametertypedescription
paramsObjectOptional.
srcNodeRefDomNode|String 
dijit._Contained (from dijit.layout._LayoutWidget), dijit._Container (from dijit.layout._LayoutWidget), dijit._Templated

Jump to PropertiesFunctionsBack to top

FunctionaddChild(child, insertIndex: Integer?)
Adds a widget to the stack
Construct the UI for this widget from a template, setting this.domNode.
FunctioncloseChild(page)
callback when user clicks the [X] to remove a page if onClose() returns true then remove and destroy the child
Functionconnect(obj: Object, event: String, method: String|Function)
Defined by dijit._Widget
Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. Special event: "ondijitclick" triggers on a click or enter-down or space-up Similar to dojo.connect() but takes three arguments rather than four.
Functioncreate(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
Kick off the life-cycle of a widget
Functiondestroy(finalize: Boolean)
Destroy this widget, but not its descendants
Defined by dijit._Widget
Recursively destroy the children of this widget and their descendants.
Defined by dijit._Widget
Destroy this widget and it's descendants. This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it's removed from the manager object.
Defined by dijit._Widget
Destroys the DOM nodes associated with this widget
Functiondisconnect(handles: Object)
Defined by dijit._Widget
Disconnects handle created by this.connect. Also removes handle from this widget's list of connects
Defined by dijit._Container
Returns array of children widgets
Defined by dijit._Widget
Returns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
FunctiongetHash(id)
get the current hash to set in localtion
Defined by dijit._Contained
Returns null if this is the last child of the parent, otherwise returns the next element sibling to the "right".
Defined by dijit._Contained
Returns the parent widget of this widget, assuming the parent implements dijit._Container
Defined by dijit._Contained
Returns null if this is the first child of the parent, otherwise returns the next element sibling to the "left".
Defined by dijit._Container
Returns true if widget has children
Defined by dijit._Widget
Return true if this widget can currently be focused and false if not
Defined by dijit._Widget
Checks the DOM to for the text direction for bi-directional support
Widgets override this method to size & position their contents/children. When this is called this._contentBox is guaranteed to be set (see resize()). This is called after startup(), and also when the widget's size has been changed.
FunctionmoveTo(number: Integer)
jump to slide based on param
FunctionnextSlide(evt)
transition to the next slide.
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves out of focus.
Defined by dijit._Widget
Callback if someone tries to close the child, child will be closed if func returns true
Defined by dijit._Widget
stub function. Override or connect to this method to receive notifications for when the widget moves into focus.
FunctiononMove(number)
stub function? TODOC: ?
Called after a widget's dom has been setup
Defined by dijit._Widget
Called after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.
Functionpostscript(params: Object?, srcNodeRef: DomNode|String)
Defined by dijit._Widget
transition to the previous slide
Removes the pane from the stack
Functionresize(args: Object?)
Explicitly set this widget's size (in pixels), and then call layout() to resize contents (and maybe adjust child widgets)
Show the given widget (which must be one of my children)
FunctionsetAttribute(attr: String, value)
Defined by dijit._Widget
Set native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
connect to the various handlers and controls for this presention
Defined by dijit._Widget
Defined by dijit._Widget
stub function. Override to implement custom widget tear-down behavior.
Function_adjacent(forward: Boolean)
Gets the next/previous child widget in this container from the current selection
Function_attachTemplateNodes(rootNode: DomNode, getAttrFunc: Function?)
Defined by dijit._Templated
Iterate through the template and attach functions and nodes accordingly.
Defined by dijit._Templated
relocate source contents to templated container node this.containerNode must be able to receive children, or exceptions will be thrown
Function_getSibling(which)
Defined by dijit._Contained
Defined by dijit._Container
Get the next or previous widget sibling of child
Function_gotoSlide(slideIndex: Integer)
goes to slide
does nothing? _that_ seems useful.
Function_hideNav(evt)
hides navigation
returns true||false base of a nodes click-ability
Defined by dijit._Widget
Function_onEvent(evt)
main presentation function, determines next 'best action' for a specified event.
Defined by dijit._Widget
resize this and children to fix this window/container
sets url #mark to direct slide access
Function_showNav(evt)
shows navigation
Defined by dijit._Templated
Function_transition(newWidget, oldWidget)
over-ride stackcontainers _transition method but atm, i find it to be ugly with not way to call _showChild() without over-riding it too. hopefull basic toggles in superclass._transition will be available in dijit, and this won't be necessary.
populate navigation select list with refs to slides call this if you add a node to your presentation dynamically.

Jump to FunctionsPropertiesBack to top

Defined by dijit._Widget
A map of attributes and attachpoints -- typically standard HTML attributes -- to set on the widget's dom, at the "domNode" attach point, by default. Other node references can be specified as properties of 'this'
Defined by dijit._Widget
HTML class attribute
Defined by dijit._Templated
holds child elements. "containerNode" is generally set via a dojoAttachPoint assignment and it designates where children of the src dom node will be placed
Defined by dijit._Widget
Unsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
if true, change the size of my currently displayed child to match my size
this is our visible representation of the widget! Other DOM Nodes may by assigned to other properties, usually through the template system's dojoAttachPonit syntax, but the domNode property is the canonical "top level" node in widget UI.
unsupported (that i know of) just yet. Default it to take control of window. Would be nice to be able to contain presentation in a styled container, like StackContainer ... theoretically possible. [and may not need this variable?]
Defined by dijit._Widget
a unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.
Defined by dijit._Widget
Rarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
time in MS fadein/out of popup nav [default: 250]
icon for navigation "next" button
if true, prevents _any_ click events to propagate actions (limiting control to keyboard and/or action.on="auto" or action.delay="" actions.
icon for navigation "previous" button
References the currently selected child widget, if any
if true, window location bar will get a #link to slide for direct access to a particular slide number.
Defined by dijit._Widget
pointer to original dom node
Defined by dijit._Widget
HTML style attribute
Defined by dijit._Templated
a node that represents the widget template. Pre-empts both templateString and templatePath.
Overrides dijit._Templated
Path to template (HTML file) for this widget relative to dojo.baseUrl
Overrides dijit._Templated
a string that represents the widget template. Pre-empts the
Defined by dijit._Widget
true to allow navigation popup, false to disallow
Defined by dijit._Templated
should we parse the template to find widgets that might be declared in markup inside it? false by default.
Defined by dijit._Widget