dijit/_KeyNavContainer.js

• Provides:

  • dijit._KeyNavContainer

• Requires:

  • dijit._Container in common

• dijit._KeyNavContainer

  • type

    Function

  • chains:
    • dijit._Container: (prototype)
    • dijit._Container: (call)
  • summary

    A _Container with keyboard navigation of its children.

  • description

    To use this mixin, call connectKeyNavHandlers() in
    postCreate() and call startupKeyNavChildren() in startup().
    It provides normalized keyboard and focusing code for Container
    widgets.

• dijit._KeyNavContainer.focusedChild

  • tags:
  • type

    Widget

  • summary

    The currently focused child widget, or null if there isn't one

• dijit._KeyNavContainer.tabIndex

  • type

    Integer

  • summary

    Tab index of the container; same as HTML tabIndex attribute.
    Note then when user tabs into the container, focus is immediately
    moved to the first item in the container.

• dijit._KeyNavContainer._keyNavCodes

  • type

    Object

• dijit._KeyNavContainer.connectKeyNavHandlers

  • parameters:
    • prevKeyCodes: (typeof dojo.keys[])
    • nextKeyCodes: (typeof dojo.keys[])

      Key codes for navigating to the next child.

  • summary

    Call in postCreate() to attach the keyboard handlers
    to the container.
    preKeyCodes: dojo.keys[]
    Key codes for navigating to the previous child.

  • tags:
  • type

    Function

• dijit._KeyNavContainer.startupKeyNavChildren

  • summary

    Call in startup() to set child tabindexes to -1

  • tags:
  • type

    Function

• dijit._KeyNavContainer.addChild

  • parameters:
    • widget: (typeof dijit._Widget)
    • insertIndex: (typeof int)
  • summary

    Add a child to our _Container

  • type

    Function

• dijit._KeyNavContainer.focus

  • summary

    Default focus() implementation: focus the first child.

  • type

    Function

• dijit._KeyNavContainer.focusFirstChild

  • summary

    Focus the first focusable child in the container.

  • tags:
  • type

    Function

• dijit._KeyNavContainer.focusLastChild

  • summary

    Focus the last focusable child in the container.

  • tags:
  • type

    Function

• dijit._KeyNavContainer.focusNext

  • summary

    Focus the next widget

  • tags:
  • type

    Function

• dijit._KeyNavContainer.focusPrev

  • summary

    Focus the last focusable node in the previous widget
    (ex: go to the ComboButton icon section rather than button section)

  • tags:
  • type

    Function

• dijit._KeyNavContainer.focusChild

  • parameters:
    • widget: (typeof dijit._Widget)

      Reference to container's child widget

    • last: (typeof Boolean)

      If true and if widget has multiple focusable nodes, focus the
      last one instead of the first one

  • summary

    Focus widget.

  • tags:
  • type

    Function

• dijit._KeyNavContainer._startupChild

  • parameters:
    • widget: (typeof dijit._Widget)
  • summary

    Setup for each child widget

  • description

    Sets tabIndex=-1 on each child, so that the tab key will
    leave the container rather than visiting each child.

  • tags:
  • type

    Function

• dijit._KeyNavContainer._onContainerFocus

  • parameters:
    • evt
  • summary

    Handler for when the container gets focus

  • description

    Initially the container itself has a tabIndex, but when it gets
    focus, switch focus to first child...

  • tags:
  • type

    Function

• dijit._KeyNavContainer._onBlur

  • parameters:
    • evt
  • type

    Function

• dijit._KeyNavContainer._onContainerKeypress

  • parameters:
    • evt
  • summary

    When a key is pressed, if it's an arrow key etc. then
    it's handled here.

  • tags:
  • type

    Function

• dijit._KeyNavContainer._onChildBlur

  • parameters:
    • widget: (typeof dijit._Widget)
  • summary

    Called when focus leaves a child widget to go
    to a sibling widget.

  • tags:
  • type

    Function

• dijit._KeyNavContainer._getFirstFocusableChild

  • returns

    dijit._Widget

  • summary

    Returns first child that can be focused

  • type

    Function

• dijit._KeyNavContainer._getLastFocusableChild

  • returns

    dijit._Widget

  • summary

    Returns last child that can be focused

  • type

    Function

• dijit._KeyNavContainer._getNextFocusableChild

  • parameters:
    • child: (typeof Widget)

      The current widget

    • dir: (typeof Integer)

      * 1 = after
      * -1 = before

  • returns

    dijit._Widget

  • summary

    Returns the next or previous focusable child, compared
    to "child"

  • type

    Function

• dijit

  • type

    Object