Warning: Use of undefined constant Symbol - assumed 'Symbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215 Warning: Use of undefined constant JavaScriptSymbol - assumed 'JavaScriptSymbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215

dijit/_Widget.js

  • Provides:

    • dijit._Widget

  • Requires:

    • dijit._WidgetBase in common
    • dijit._base in common

  • dijit._Widget

    • type
      Function
    • chains:
      • dijit._WidgetBase: (prototype)
      • dijit._WidgetBase: (call)
    • summary
      Base class for all Dijit widgets.

Extends _WidgetBase, adding support for:
- deferred connections
A call like dojo.connect(myWidget, "onMouseMove", func)
will essentially do a dojo.connect(myWidget.domNode, "onMouseMove", func)
- ondijitclick
Support new dojoAttachEvent="ondijitclick: ..." that is triggered by a mouse click or a SPACE/ENTER keypress
- focus related functions
In particular, the onFocus()/onBlur() callbacks.   Driven internally by
dijit/_base/focus.js.
- deprecated methods
- onShow(), onHide(), onClose()

Also, by loading code in dijit/_base, turns on:
- browser sniffing (putting browser id like .dj_ie on <html> node)
- high contrast mode sniffing (add .dijit_a11y class to <body> if machine is in high contrast mode)

  • dijit._Widget._deferredConnects

    • tags:
    • type
      Object
    • summary
      attributeMap addendum for event handlers that should be connected only on first use

  • dijit._Widget._deferredConnects.onClick

    • type
      String

  • dijit._Widget._deferredConnects.onDblClick

    • type
      String

  • dijit._Widget._deferredConnects.onKeyDown

    • type
      String

  • dijit._Widget._deferredConnects.onKeyPress

    • type
      String

  • dijit._Widget._deferredConnects.onKeyUp

    • type
      String

  • dijit._Widget._deferredConnects.onMouseMove

    • type
      String

  • dijit._Widget._deferredConnects.onMouseDown

    • type
      String

  • dijit._Widget._deferredConnects.onMouseOut

    • type
      String

  • dijit._Widget._deferredConnects.onMouseOver

    • type
      String

  • dijit._Widget._deferredConnects.onMouseLeave

    • type
      String

  • dijit._Widget._deferredConnects.onMouseEnter

    • type
      String

  • dijit._Widget._deferredConnects.onMouseUp

    • type
      String

  • dijit._Widget.onClick

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof mouse)
        Event
    • summary
      Connect to this function to receive notifications of mouse click events.
    • tags: callback
    • type
      Function

  • dijit._Widget.onDblClick

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof mouse)
        Event
    • summary
      Connect to this function to receive notifications of mouse double click events.
    • tags: callback
    • type
      Function

  • dijit._Widget.onKeyDown

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof key)
        Event
    • summary
      Connect to this function to receive notifications of keys being pressed down.
    • tags: callback
    • type
      Function

  • dijit._Widget.onKeyPress

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof key)
        Event
    • summary
      Connect to this function to receive notifications of printable keys being typed.
    • tags: callback
    • type
      Function

  • dijit._Widget.onKeyUp

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof key)
        Event
    • summary
      Connect to this function to receive notifications of keys being released.
    • tags: callback
    • type
      Function

  • dijit._Widget.onMouseDown

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof mouse)
        Event
    • summary
      Connect to this function to receive notifications of when the mouse button is pressed down.
    • tags: callback
    • type
      Function

  • dijit._Widget.onMouseMove

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof mouse)
        Event
    • summary
      Connect to this function to receive notifications of when the mouse moves over nodes contained within this widget.
    • tags: callback
    • type
      Function

  • dijit._Widget.onMouseOut

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof mouse)
        Event
    • summary
      Connect to this function to receive notifications of when the mouse moves off of nodes contained within this widget.
    • tags: callback
    • type
      Function

  • dijit._Widget.onMouseOver

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof mouse)
        Event
    • summary
      Connect to this function to receive notifications of when the mouse moves onto nodes contained within this widget.
    • tags: callback
    • type
      Function

  • dijit._Widget.onMouseLeave

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof mouse)
        Event
    • summary
      Connect to this function to receive notifications of when the mouse moves off of this widget.
    • tags: callback
    • type
      Function

  • dijit._Widget.onMouseEnter

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof mouse)
        Event
    • summary
      Connect to this function to receive notifications of when the mouse moves onto this widget.
    • tags: callback
    • type
      Function

  • dijit._Widget.onMouseUp

    • alias - dijit._connectOnUseEventHandler
    • parameters:
      • event: (typeof mouse)
        Event
    • summary
      Connect to this function to receive notifications of when the mouse button is released.
    • tags: callback
    • type
      Function

  • dijit._Widget.create

    • parameters:
      • params: (typeof Object)
      • srcNodeRef: (typeof DomNode|String)
    • type
      Function

  • dijit._Widget._onConnect

    • parameters:
      • event: (typeof String)
    • summary
      Called when someone connects to one of my handlers.
"Turn on" that handler if it isn't active yet.

This is also called for every single initialization parameter
so need to do nothing for parameters like "id".
    • tags:
    • type
      Function

  • dijit._Widget.focused

    • tags: readonly
    • type
      Boolean
    • summary
      This widget or a widget it contains has focus, or is "active" because
it was recently clicked.

  • dijit._Widget.isFocusable

    • summary
      Return true if this widget can currently be focused
and false if not
    • type
      Function

  • dijit._Widget.onFocus

    • summary
      Called when the widget becomes "active" because
it or a widget inside of it either has focus, or has recently
been clicked.
    • tags: callback
    • type
      Function

  • dijit._Widget.onBlur

    • summary
      Called when the widget stops being "active" because
focus moved to something outside of it, or the user
clicked somewhere outside of it, or the widget was
hidden.
    • tags: callback
    • type
      Function

  • dijit._Widget._onFocus

    • parameters:
      • e
    • summary
      This is where widgets do processing for when they are active,
such as changing CSS classes.  See onFocus() for more details.
    • tags:
    • type
      Function

  • dijit._Widget._onBlur

    • summary
      This is where widgets do processing for when they stop being active,
such as changing CSS classes.  See onBlur() for more details.
    • tags:
    • type
      Function

  • dijit._Widget.setAttribute

    • parameters:
      • attr: (typeof String)
      • value: (typeof anything)
    • summary
      Deprecated.  Use set() instead.
    • tags:
    • type
      Function

  • dijit._Widget.attr

    • parameters:
      • name: (typeof String|Object)
        The property to get or set. If an object is passed here and not
a string, its keys are used as names of attributes to be set
and the value of the object as values to set in the widget.
      • value: (typeof Object)
        Optional. If provided, attr() operates as a setter. If omitted,
the current value of the named property is returned.
    • summary
      Set or get properties on a widget instance.
    • description
      This method is deprecated, use get() or set() directly.
    • type
      Function

  • dijit._Widget.nodesWithKeyClick

    • tags:
    • type
      String[]
    • summary
      List of nodes that correctly handle click events via native browser support,
and don't need dijit's help

  • dijit._Widget.connect

    • parameters:
      • obj: (typeof Object|null)
      • event: (typeof String|Function)
      • method: (typeof String|Function)
    • returns
      _Widget.Handle
    • summary
      Connects specified obj/event to specified method of this object
and registers for disconnect() on widget destroy.
    • description
      Provide widget-specific analog to dojo.connect, except with the
implicit use of this widget as the target object.
This version of connect also provides a special "ondijitclick"
event which triggers on a click or space or enter keyup.
Events connected with `this.connect` are disconnected upon
destruction.
    • return_summary
      A handle that can be passed to `disconnect` in order to disconnect before
the widget is destroyed.
    • example
      	var btn = new dijit.form.Button();
	// when foo.bar() is called, call the listener we're going to
	// provide in the scope of btn
	btn.connect(foo, "bar", function(){
		console.debug(this.toString());
	});
    • tags:
    • type
      Function

  • dijit._Widget._onShow

    • summary
      Internal method called when this widget is made visible.
See <code>onShow</code> for details.
    • type
      Function

  • dijit._Widget.onShow

    • summary
      Called when this widget becomes the selected pane in a
<code>dijit.layout.TabContainer</code>, <code>dijit.layout.StackContainer</code>,
<code>dijit.layout.AccordionContainer</code>, etc.

Also called to indicate display of a <code>dijit.Dialog</code>, <code>dijit.TooltipDialog</code>, or <code>dijit.TitlePane</code>.
    • tags: callback
    • type
      Function

  • dijit._Widget.onHide

    • summary
      Called when another widget becomes the selected pane in a
<code>dijit.layout.TabContainer</code>, <code>dijit.layout.StackContainer</code>,
<code>dijit.layout.AccordionContainer</code>, etc.

Also called to indicate hide of a <code>dijit.Dialog</code>, <code>dijit.TooltipDialog</code>, or <code>dijit.TitlePane</code>.
    • tags: callback
    • type
      Function

  • dijit._Widget.onClose

    • returns
      Boolean
    • summary
      Called when this widget is being displayed as a popup (ex: a Calendar popped
up from a DateTextBox), and it is hidden.
This is called from the dijit.popup code, and should not be called directly.

Also used as a parameter for children of <code>dijit.layout.StackContainer</code> or subclasses.
Callback if a user tries to close the child.   Child will be closed if this function returns true.
    • tags: extension
    • type
      Function

  • dijit._connectOnUseEventHandler

    • parameters:
      • event: (typeof Event)
    • type
      Function

  • dijit._lastKeyDownNode

    • alias - evt.target
    • type
      Object

  • dijit

    • type
      Object