dojox/mobile/ScrollablePane (version 1.10)

Aborts scrolling.

This function stops the scrolling animation that is currently running. It is called when the user touches the screen while scrolling.

Adds the transparent DIV cover.

The cover is to prevent DOM events from affecting the child widgets such as a list widget. Without the cover, for example, child widgets may receive a click event and respond to it unexpectedly when the user flicks the screen to scroll. Note that only the desktop browsers need the cover.

A stub function to be overridden by subclasses.

This function is called from onTouchEnd(). The purpose is to give its subclasses a chance to adjust the destination position. If this function returns false, onTouchEnd() returns immediately without performing scroll.

Calculates the scroll bar position.

Given the scroll destination position, calculates the top and/or the left of the scroll bar(s). Returns an object with x and y.

Calculate the speed given the distance and time.

Checks if the given node is a fixed bar or not.

Uninitialize the module.

Deprecated, will be removed in 2.0, use this.own(on(...)) or this.own(aspect.after(...)) instead.

Connects specified obj/event to specified method of this object and registers for disconnect() on widget destroy.

Provide widget-specific analog to dojo.connect, except with the implicit use of this widget as the target object. Events connected with this.connect are disconnected upon destruction.

Creates a mask for a scroll bar edge.

This function creates a mask that hides corners of one scroll bar edge to make it round edge. The other side of the edge is always visible and round shaped with the border-radius style.

Wrapper to setTimeout to avoid deferred functions executing after the originating widget has been destroyed. Returns an object handle with a remove method (that returns null) (replaces clearTimeout).

Destroy this widget, but not its descendants. Descendants means widgets inside of this.containerNode. Will also destroy any resources (including widgets) registered via this.own().

This method will also destroy internal widgets such as those created from a template, assuming those widgets exist inside of this.domNode but outside of this.containerNode.

For 2.0 it's planned that this method will also destroy descendant widgets, so apps should not depend on the current ability to destroy a widget without destroying its descendants. Generally they should use destroyRecursive() for widgets with children.

Recursively destroy the children of this widget and their descendants.

Destroy this widget and its 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 is removed from the manager object.

Destroys the DOM nodes associated with this widget.

Deprecated, will be removed in 2.0, use handle.remove() instead.

Disconnects handle created by connect.

Used by widgets to signal that a synthetic event occurred, ex:

myWidget.emit("attrmodified-selectedChildWidget", {}).

Emits an event on this.domNode named type.toLowerCase(), based on eventObj. Also calls onType() method, if present, and returns value from that method. By default passes eventObj to callback, but will pass callbackArgs instead, if specified. Modifies eventObj by adding missing parameters (bubbles, cancelable, widget).

Search for application-specific header or footer.

Finds the currently displayed view node from my sibling nodes.

Shows the scroll bar instantly.

This function shows the scroll bar, and then hides it 300ms later. This is used to show the scroll bar to the user for a short period of time when a hidden view is revealed.

Get a property from a widget.

Get a named property from a widget. The property may potentially be retrieved via a getter method. If no getter is defined, this just retrieves the object's property.

For example, if the widget has properties foo and bar and a method named _getFooAttr(), calling: myWidget.get("foo") would be equivalent to calling widget._getFooAttr() and myWidget.get("bar") would be equivalent to the expression widget.bar2

Returns all direct children of this widget, i.e. all widgets underneath this.containerNode whose parent is this widget. Note that it does not return all descendants, but rather just direct children. Analogous to Node.childNodes, except containing widgets rather than DOMNodes.

The result intentionally excludes internally created widgets (a.k.a. supporting widgets) outside of this.containerNode.

Note that the array returned is a simple array. Application code should not assume existence of methods like forEach().

Returns various internal dimensional information needed for calculation.

Returns the index of this widget within its container parent. It returns -1 if the parent does not exist, or if the parent is not a dijit/_Container

Returns null if this is the last child of the parent, otherwise returns the next element sibling to the "right".

Returns the parent widget of this widget.

Gets the top position in the midst of animation.

Returns null if this is the first child of the parent, otherwise returns the next element sibling to the "left".

Returns the dimensions of the browser window.

Returns an object that indicates the scrolling speed.

From the position and elapsed time information, calculates the scrolling speed, and returns an object with x and y.

Hides the scroll bar.

If the fadeScrollBar property is true, hides the scroll bar with the fade animation.

Initialize according to the given params.

Mixes in the given params into this instance. At least domNode and containerNode have to be given. Starts listening to the touchstart events. Calls resize(), if this widget is a top level widget.

Return true if this widget can currently be focused and false if not

Returns true if the given node is a form control.

Return this widget's explicit or implicit orientation (true for LTR, false for RTL)

Constructs a string value that is passed to the -webkit-transform property.

Return value example: "translate3d(0px,-8px,0px)"

Call specified function when event occurs, ex: myWidget.on("click", function(){ ... }).

Call specified function when event type occurs, ex: myWidget.on("click", function(){ ... }). Note that the function is not run in any particular scope, so if (for example) you want it to run in the widget's scope you must do myWidget.on("click", lang.hitch(myWidget, func)).

Track specified handles and remove/destroy them when this instance is destroyed, unless they were already removed/destroyed manually.

Place this widget somewhere in the DOM based on standard domConstruct.place() conventions.

A convenience function provided in all _Widgets, providing a simple shorthand mechanism to put an existing (or newly created) Widget somewhere in the dom, and allow chaining.

Processing after the DOM fragment is created

Called after the DOM fragment has been created, but not necessarily added to the document. Do not include any operations which rely on node dimensions or placement.

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.

Removes the transparent DIV cover.

Resets the scroll bar length, position, etc.

Scrolls the pane until the searching node is in the view.

Just like the scrollIntoView method of DOM elements, this function causes the given node to scroll into view, aligning it either at the top or bottom of the pane.

Moves the scroll bar(s) to the given position without animation.

Scrolls to the given position immediately without animation.

Set a property on a widget

Sets named properties on a widget which may potentially be handled by a setter in the widget.

For example, if the widget has properties foo and bar and a method named _setFooAttr(), calling myWidget.set("foo", "Howdy!") would be equivalent to calling widget._setFooAttr("Howdy!") and myWidget.set("bar", 3) would be equivalent to the statement widget.bar = 3;

set() may also be called with a hash of name/value pairs, ex:

myWidget.set({
    foo: "Howdy",
    bar: 3
});

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

Programmatically sets key frames for the scroll animation.

Sets the given node as selectable or unselectable.

Shows the scroll bar.

This function creates the scroll bar instance if it does not exist yet, and calls resetScrollBar() to reset its length and position.

Moves the scroll bar(s) to the given position with the slide animation.

Scrolls to the given position with the slide animation.

Processing after the DOM fragment is added to the document

Called after a widget and its children have been created and added to the page, and all related widgets have finished their create() cycle, up through postCreate().

Note that startup() may be called while the widget is still hidden, for example if the widget is inside a hidden dijit/Dialog or an unselected tab of a dijit/layout/TabContainer. For widgets that need to do layout, it's best to put that layout code inside resize(), and then extend dijit/layout/_LayoutWidget so that resize() is called when the widget is visible.

Stops the currently running animation.

Deprecated, will be removed in 2.0, use this.own(topic.subscribe()) instead.

Subscribes to the specified topic and calls the specified method of this object and registers for unsubscribe() on widget destroy.

Provide widget-specific analog to dojo.subscribe, except with the implicit use of this widget as the target object.

Returns a string that represents the widget.

When a widget is cast to a string, this method will be used to generate the output. Currently, it does not implement any sort of reversible serialization.

Deprecated. Override destroy() instead to implement custom widget tear-down behavior.

Deprecated, will be removed in 2.0, use handle.remove() instead.

Unsubscribes handle created by this.subscribe. Also removes handle from this widget's list of subscriptions

Watches a property for changes

called after a scroll has been performed.

called before a scroll is initiated. If this method returns false, the scroll is canceled.

User-defined function to handle touchEnd events.

User-defined function to handle touchMove events.

User-defined function to handle touchStart events.