dijit/form/_ListBase (version 1.10)

Summary

Focus-less menu to handle UI events consistently. Abstract methods that must be defined externally:

See the dijit/form/_ListBase reference documentation for more information.

Property Summary

Method Summary

  • _listConnect(eventType,callbackFuncName) Connects 'containerNode' to specified method of this object and automatically registers for 'disconnect' on widget destroy.
  • _setSelectedAttr(node,scroll) Does the actual select.
  • selectFirstNode() Select the first displayed item in the list.
  • selectLastNode() Select the last displayed item in the list
  • selectNextNode() Select the item just below the current selection.
  • selectPreviousNode() Select the item just above the current selection.

Properties

selected
Defined by: dijit/form/_ListBase

currently selected node

Methods

_listConnect(eventType,callbackFuncName)

Connects 'containerNode' to specified method of this object and automatically registers for 'disconnect' on widget destroy.

Provide widget-specific analog to 'connect'. The callback function is called with the normal event object, but also a second parameter is passed that indicates which list item actually received the event.

Parameter Type Description
eventType String | Function
callbackFuncName String
Returns:any | undefined

A handle that can be passed to disconnect in order to disconnect before the widget is destroyed.

_setSelectedAttr(node,scroll)

Does the actual select.

Parameter Type Description
node DomNode

The option to select

scroll Boolean

If necessary, scroll node into view. Set to false for mouse/touch to avoid jumping problems on mobile/RTL, see https://bugs.dojotoolkit.org/ticket/17739.

selectFirstNode()

Select the first displayed item in the list.

selectLastNode()

Select the last displayed item in the list

selectNextNode()

Select the item just below the current selection. If nothing selected, select first node.

selectPreviousNode()

Select the item just above the current selection. If nothing selected, select last node (if you select Previous and try to keep scrolling up the list).

Error in the documentation? Can’t find what you are looking for? Let us know!