dijit/_base/typematic.js

• Provides:

  • dijit._base.typematic

• dijit.typematic

  • summary

    These functions are used to repetitively call a user specified callback
    method when a specific key or mouse click over a specific DOM node is
    held down for a specific amount of time.
    Only 1 such event is allowed to occur on the browser page at 1 time.

  • attached - dijit
  • type

    Object

• dijit.typematic._fireEventAndReload

  • private - 1
  • type

    Function

  • classlike

• dijit.typematic._fireEventAndReload._timer

  • instance - dijit.typematic._fireEventAndReload
  • private - 1
  • private_parent - 1
  • type

    Object

• dijit.typematic._fireEventAndReload._currentTimeout

  • instance - dijit.typematic._fireEventAndReload
  • private - 1
  • private_parent - 1
  • type

    Object

• dijit.typematic.trigger

  • parameters:
    • evt: (typeof Event)

      key or mouse event object

    • _this: (typeof Object)

      pointer to the user's widget space.

    • node: (typeof DOMNode)

      the DOM node object passed in

    • callback: (typeof Function)

      function to call until the sequence is stopped called with 3 parameters:
      count:
      integer representing number of repeated calls (0..n) with -1 indicating the iteration has stopped

    • obj: (typeof Object)

      user space object used to uniquely identify each typematic sequence
      subsequentDelay (optional):
      if > 1, the number of milliseconds until the 3->n events occur
      or else the fractional time multiplier for the next event's delay, default=0.9
      initialDelay (optional):
      the number of milliseconds until the 2nd event occurs, default=500ms
      minDelay (optional):
      the maximum delay in milliseconds for event to fire, default=10ms

    • subsequentDelay: (typeof Number)
    • initialDelay: (typeof Number)
    • minDelay: (typeof Number)
  • summary

    Start a timed, repeating callback sequence.
    If already started, the function call is ignored.
    This method is not normally called by the user but can be
    when the normal listener code is insufficient.

  • type

    Function

  • classlike

• dijit.typematic.trigger._initialDelay

  • instance - dijit.typematic.trigger
  • private - 1
  • type

    Number

• dijit.typematic.trigger._subsequentDelay

  • instance - dijit.typematic.trigger
  • private - 1
  • type

    Number

• dijit.typematic.trigger._minDelay

  • instance - dijit.typematic.trigger
  • private - 1
  • type

    Number

• dijit.typematic.trigger._obj

  • instance - dijit.typematic.trigger
  • private - 1

• dijit.typematic.trigger._evt

  • instance - dijit.typematic.trigger
  • private - 1
  • type

    Object

• dijit.typematic.trigger._node

  • instance - dijit.typematic.trigger
  • private - 1

• dijit.typematic.trigger._currentTimeout

  • instance - dijit.typematic.trigger
  • private - 1
  • type

    Number

• dijit.typematic.trigger._count

  • instance - dijit.typematic.trigger
  • private - 1
  • type

    Number

• dijit.typematic.trigger._callback

  • instance - dijit.typematic.trigger
  • private - 1
  • type

    Object

• dijit.typematic.stop

  • summary

    Stop an ongoing timed, repeating callback sequence.

  • type

    Function

  • classlike

• dijit.typematic.stop._timer

  • instance - dijit.typematic.stop
  • private - 1
  • type

    Object

• dijit.typematic.stop._obj

  • instance - dijit.typematic.stop
  • private - 1
  • type

    Object

• dijit.typematic.addKeyListener

  • parameters:
    • node: (typeof DOMNode)
    • keyObject: (typeof Object)

      an object defining the key to listen for:
      charOrCode:
      the printable character (string) or keyCode (number) to listen for.
      keyCode:
      (deprecated - use charOrCode) the keyCode (number) to listen for (implies charCode = 0).
      charCode:
      (deprecated - use charOrCode) the charCode (number) to listen for.
      ctrlKey:
      desired ctrl key state to initiate the callback sequence:
      - pressed (true)
      - released (false)
      - either (unspecified)
      altKey:
      same as ctrlKey but for the alt key
      shiftKey:
      same as ctrlKey but for the shift key

    • _this: (typeof Object)
    • callback: (typeof Function)
    • subsequentDelay: (typeof Number)
    • initialDelay: (typeof Number)
    • minDelay: (typeof Number)
  • deprecated - 1
  • summary

    Start listening for a specific typematic key.
    See also the trigger method for other parameters.

  • return_summary

    an array of dojo.connect handles

  • type

    Function

• dijit.typematic.addMouseListener

  • parameters:
    • node: (typeof DOMNode)
    • _this: (typeof Object)
    • callback: (typeof Function)
    • subsequentDelay: (typeof Number)
    • initialDelay: (typeof Number)
    • minDelay: (typeof Number)
  • summary

    Start listening for a typematic mouse click.
    See the trigger method for other parameters.

  • return_summary

    an array of dojo.connect handles

  • type

    Function

• dijit.typematic.addListener

  • parameters:
    • mouseNode: (typeof Node)

      the DOM node object to listen on for mouse events.

    • keyNode: (typeof Node)

      the DOM node object to listen on for key events.

    • keyObject: (typeof Object)
    • _this: (typeof Object)
    • callback: (typeof Function)
    • subsequentDelay: (typeof Number)
    • initialDelay: (typeof Number)
    • minDelay: (typeof Number)
  • summary

    Start listening for a specific typematic key and mouseclick.
    This is a thin wrapper to addKeyListener and addMouseListener.
    See the addMouseListener and addKeyListener methods for other parameters.

  • return_summary

    an array of dojo.connect handles

  • type

    Function

• dijit._base.typematic

  • type

    Object

  • private_parent - 1

• dijit._base

  • type

    Object

  • private - 1

• dijit

  • type

    Object