dojox/grid/enhanced/plugins/AutoScroll (version 1.10)

dojox/grid/enhanced/_Plugin

Summary

Provides horizontal and vertical auto-scroll for grid.

Usage

var foo = new AutoScroll(grid,args);
dojox/grid/enhanced/plugins/AutoScroll
Parameter Type Description
grid undefined
args undefined

Property Summary

  • _connectsList of all connections.
  • _subscribesList of all subscribes.
  • autoScrollIntervalThe time interval (in miliseconds) between 2 scrolling.
  • autoScrollMarginThe width (in pixel) of the margin area where autoscroll can be triggered.
  • gridGrid that the plugin belongs to
  • namePlugin name
  • optionPlugin properties - leveraged with default and user specified properties. e.g. for dnd plugin, it may look like {"class": dojox.grid.enhanced.plugins.DnD, "dependency": ["nestedSorting"], ...}
  • privatesPrivate properties/methods shouldn't be mixin-ed anytime.

Method Summary

Event Summary

Properties

_connects

List of all connections.

_subscribes

List of all subscribes.

autoScrollInterval

The time interval (in miliseconds) between 2 scrolling.

autoScrollMargin

The width (in pixel) of the margin area where autoscroll can be triggered.

grid

Grid that the plugin belongs to

name

Plugin name

option

Plugin properties - leveraged with default and user specified properties. e.g. for dnd plugin, it may look like {"class": dojox.grid.enhanced.plugins.DnD, "dependency": ["nestedSorting"], ...}

privates

Private properties/methods shouldn't be mixin-ed anytime.

Methods

_autoScroll(isVertical,isForward,view)
Parameter Type Description
isVertical undefined
isForward undefined
view undefined
_fireEvent(eventName,args)
Parameter Type Description
eventName undefined
args undefined
_initEvents()
_manageAutoScroll(toStop,isVertical,isForward,view)
Parameter Type Description
toStop undefined
isVertical undefined
isForward undefined
view undefined
_mixinGrid()
_scrollColumn(isForward,view)
Parameter Type Description
isForward undefined
view undefined
Returns:undefined
connect(obj,event,method)

Connects specified obj/event to specified method of this object.

Parameter Type Description
obj undefined
event undefined
method undefined
Returns:undefined

Examples

Example 1

var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when foo.bar() is called, call the listener in the scope of plugin
plugin.connect(foo, "bar", function(){
    console.debug(this.xxx());//"this" - plugin scope
});
destroy()

Destroy all resources.

disconnect(handle)

Disconnects handle and removes it from connection list.

Parameter Type Description
handle undefined
init()
subscribe(topic,method)

Subscribes to the specified topic and calls the specified method of this object.

Parameter Type Description
topic undefined
method undefined
Returns:undefined

Examples

Example 1

var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
    console.debug(this.xxx(v));//"this" - plugin scope
});
unsubscribe(handle)

Un-subscribes handle and removes it from subscriptions list.

Parameter Type Description
handle undefined

Events

onPostInit()

Examples

Example 1

var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
    console.debug(this.xxx(v));//"this" - plugin scope
});
onPreInit()

Examples

Example 1

var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
    console.debug(this.xxx(v));//"this" - plugin scope
});
onSetStore(store)

Called when store is changed.

Parameter Type Description
store undefined

Examples

Example 1

var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
    console.debug(this.xxx(v));//"this" - plugin scope
});
onStartUp()

Examples

Example 1

var plugin = new dojox.grid.enhanced._Plugin(grid,"myPlugin",{...});
// when /my/topic is published, call the subscriber in the scope of plugin
// with passed parameter - "v"
plugin.subscribe("/my/topic", function(v){
    console.debug(this.xxx(v));//"this" - plugin scope
});
Error in the documentation? Can’t find what you are looking for? Let us know!