dijit/_base/focus.js

• Provides:

  • dijit._base.focus

• Requires:

  • dojo.window in common
  • dijit._base.manager in common

• dijit._curFocus

  • type

    DomNode

  • summary

    Currently focused item on screen

• dijit._prevFocus

  • type

    DomNode

  • summary

    Previously focused item on screen

• dijit.isCollapsed

  • summary

    Returns true if there is no text selected

  • type

    Function

• dijit.getBookmark

  • returns

    Object.|Object

  • summary

    Retrieves a bookmark that can be used with moveToBookmark to return to the same range

  • type

    Function

• dijit.moveToBookmark

  • parameters:
    • bookmark: (typeof Object)

      This should be a returned object from dijit.getBookmark()

  • summary

    Moves current selection to a bookmark

  • type

    Function

• dijit.getFocus

  • parameters:
    • menu: (typeof Widget)

      dijit._Widget or {domNode: DomNode} structure
      The button that was just pressed.  If focus has disappeared or moved
      to this button, returns the previous focus.  In this case the bookmark
      information is already lost, and null is returned.

    • openedForWindow: (typeof Window)

      iframe in which menu was opened

  • summary

    Called as getFocus(), this returns an Object showing the current focus
    and selected text.
    
    Called as getFocus(widget), where widget is a (widget representing) a button
    that was just pressed, it returns where focus was before that button
    was pressed.   (Pressing the button may have either shifted focus to the button,
    or removed focus altogether.)   In this case the selected text is not returned,
    since it can't be accurately determined.

  • return_summary

    A handle to restore focus/selection, to be passed to `dijit.focus`

  • type

    Function

• dijit.focus

  • parameters:
    • handle: (typeof Object)

      object returned by get(), or a DomNode

  • summary

    Sets the focused node and the selection according to argument.
    To set focus to an iframe's content, pass in the iframe itself.

  • type

    Function

• dijit._activeStack

  • type

    dijit._Widget[]

  • summary

    List of currently active widgets (focused widget and it's ancestors)

• dijit.registerIframe

  • parameters:
    • iframe: (typeof DomNode)
  • summary

    Registers listeners on the specified iframe so that any click
    or focus event on that iframe (or anything in it) is reported
    as a focus/click event on the <iframe> itself.

  • description

    Currently only used by editor.

  • return_summary

    Handle to pass to unregisterIframe()

  • type

    Function

• dijit.unregisterIframe

  • parameters:
    • handle: (typeof Object)

      Handle returned by registerIframe()

  • summary

    Unregisters listeners on the specified iframe created by registerIframe.
    After calling be sure to delete or null out the handle itself.

  • type

    Function

• dijit.registerWin

  • parameters:
    • targetWindow: (typeof Window)

      If specified this is the window associated with the iframe,
      i.e. iframe.contentWindow.

    • effectiveNode: (typeof DomNode)

      If specified, report any focus events inside targetWindow as
      an event on effectiveNode, rather than on evt.target.

  • summary

    Registers listeners on the specified window (either the main
    window or an iframe's window) to detect when the user has clicked somewhere
    or focused somewhere.

  • description

    Users should call registerIframe() instead of this method.

  • return_summary

    Handle to pass to unregisterWin()

  • type

    Function

• dijit.unregisterWin

  • parameters:
    • handle: (typeof Handle)
  • summary

    Unregisters listeners on the specified window (either the main
    window or an iframe's window) according to handle returned from registerWin().
    After calling be sure to delete or null out the handle itself.

  • type

    Function

• dijit._onBlurNode

  • parameters:
    • node: (typeof DomNode)
  • summary

    Called when focus leaves a node.
    Usually ignored, _unless_ it *isn't* follwed by touching another node,
    which indicates that we tabbed off the last field on the page,
    in which case every widget is marked inactive

  • type

    Function

• dijit._onTouchNode

  • parameters:
    • node: (typeof DomNode)

      The node that was touched.

    • by: (typeof String)

      "mouse" if the focus/touch was caused by a mouse down event

  • summary

    Callback when node is focused or mouse-downed

  • type

    Function

• dijit._onFocusNode

  • parameters:
    • node: (typeof DomNode)
  • summary

    Callback when node is focused

  • type

    Function

• dijit._setStack

  • parameters:
    • newStack: (typeof String[])

      array of widget id's, starting from the top (outermost) widget

    • by: (typeof String)

      "mouse" if the focus/touch was caused by a mouse down event

  • summary

    The stack of active widgets has changed.  Send out appropriate events and records new stack.

  • type

    Function

• dijit._base.focus

  • type

    Object

• dijit._base

  • type

    Object

• dijit

  • type

    Object