Methods

This section describes the members used to manipulate the widget.

beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not raise events, and does not update the UI until the endUpdate method is called. Using these methods prevents excessive component updates when changing multiple component settings at once.

content()

Returns an HTML element representing the widget.

Return Value: Object

An element representing in widget.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not raise events, and does not update the UI until the endUpdate method is called. Using these methods prevents excessive component updates when changing multiple component settings at once.

instance()

Returns an instance of this component class.

Return Value: Object

An instance of this component class

Use this method to access other methods of the component.

option()

Returns the configuration options of this component.

Return Value: Object

An object representing the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

Parameters:
optionName: String

The name of the option to get.

Return Value: any

The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

Parameters:
optionName: String

The name of the required option.

optionValue: any

The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

option(options)

Sets one or more options of this component.

Parameters:
options: Object

An object containing the required configuration options.

release(preventScrollBottom)

Notifies the scroll view that data loading is finished.

Parameters:
preventScrollBottom: Boolean

Indicates whether or not to prevent reachBottom action execution.

Return Value: Object

A Deferred jQuery object.

Use this method to hide the load indicator and release the scroll view after pullDownAction or reachBottomAction has been executed.

Show Example:
jQuery

scrollBy(distance, doAnimate)

Scrolls the widget content by the specified number of pixels.

Parameters:
distance: Number

The scrolling distance in pixels.

doAnimate: Boolean

A Boolean value specifying whether or not to animate scrolling.

Return Value: Object

A Deferred jQuery object.

Show Example:
jQuery

scrollPos(pos)

Sets the current scroll position.

Parameters:
pos: Number

The distance from the top position to the required position in pixels.

Show Example:
jQuery

scrollTo(pos, doAnimate)

Scrolls the widget content to the specified position.

Parameters:
pos: Number

The distance from the top position to the required position in pixels.

doAnimate: Boolean

A Boolean value specifying whether or not to animate scrolling.

Return Value: Object

A Deferred jQuery object.

Show Example:
jQuery

stop(jumpToEnd)

Stops scrolling.

Parameters:
jumpToEnd: Boolean

A Boolean value specifying whether to jump to the target position (true), or to stop scrolling at the current position (false).

Return Value: jQuery.Promise

A Deferred jQuery object.

Show Example:
jQuery

update(doAnimate)

Updates the widget state.

Parameters:
doAnimate: Boolean

A Boolean value indicating whether to enable or disable animation when updating the widget state.

Return Value: Object

A Deferred jQuery object.

Use this method to fit the widget contents to the widget size after the widget size has been changed.

Show Example:
jQuery