dijit/Tooltip.js

• Provides:

  • dijit.Tooltip

• Requires:

  • dijit._Widget in common
  • dijit._Templated in common

• dijit._MasterTooltip

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    Internal widget that holds the actual tooltip markup,
    which occurs once per page.
    Called by Tooltip widgets which are just containers to hold
    the markup

  • tags:

• dijit._MasterTooltip.duration

  • alias - dijit.defaultDuration
  • type

    Integer

  • summary

    Milliseconds to fade in/fade out

• dijit._MasterTooltip.templateString

  • type

    Object

• dijit._MasterTooltip.postCreate

  • type

    Function

• dijit._MasterTooltip.bgIframe

  • type

    Object

• dijit._MasterTooltip.fadeIn

  • type

    Object

• dijit._MasterTooltip.fadeOut

  • type

    Object

• dijit._MasterTooltip.show

  • parameters:
    • innerHTML: (typeof String)
    • aroundNode: (typeof DomNode)
    • position: (typeof String[])
    • rtl: (typeof Boolean)
  • summary

    Display tooltip w/specified contents to right of specified node
    (To left if there's no space on the right, or if rtl == true)

  • type

    Function

• dijit._MasterTooltip.domNode.width

  • type

    String

• dijit._MasterTooltip._onDeck

  • type

    Object

• dijit._MasterTooltip.containerNode.innerHTML

  • type

    String

• dijit._MasterTooltip.isShowingNow

  • type

    bool

• dijit._MasterTooltip.aroundNode

  • type

    Object

• dijit._MasterTooltip.orient

  • parameters:
    • node: (typeof DomNode)
    • aroundCorner: (typeof String)
    • tooltipCorner: (typeof String)
    • spaceAvailable: (typeof Object)
    • aroundNodeCoords: (typeof Object)
  • summary

    Private function to set CSS for tooltip node based on which position it's in.
    This is called by the dijit popup code.   It will also reduce the tooltip's
    width to whatever width is available

  • tags:
  • type

    Function

• dijit._MasterTooltip.connectorNode.style.top

  • type

    String

• dijit._MasterTooltip.domNode.style.width

  • type

    String

• dijit._MasterTooltip.containerNode.style.overflow

  • type

    String

• dijit._MasterTooltip.connectorNode.offsetHeight

• dijit._MasterTooltip.connectorNode.style.bottom

  • type

    String

• dijit._MasterTooltip._onShow

  • summary

    Called at end of fade-in operation

  • tags:
  • type

    Function

• dijit._MasterTooltip.domNode.style.filter

  • type

    String

• dijit._MasterTooltip.hide

  • parameters:
    • aroundNode
  • summary

    Hide the tooltip

  • type

    Function

• dijit._MasterTooltip._onHide

  • summary

    Called at end of fade-out operation

  • tags:
  • type

    Function

• dijit._MasterTooltip.domNode.style.cssText

  • type

    String

• dijit.Tooltip

  • type

    Function

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

    Pops up a tooltip (a help message) when you hover over a node.

• dijit.Tooltip.label

  • type

    String

  • summary

    Text to display in the tooltip.
    Specified as innerHTML when creating the widget from markup.

• dijit.Tooltip.showDelay

  • type

    Integer

  • summary

    Number of milliseconds to wait after hovering over/focusing on the object, before
    the tooltip is displayed.

• dijit.Tooltip.connectId

  • type

    String|String[]

  • summary

    Id of domNode(s) to attach the tooltip to.
    When user hovers over specified dom node, the tooltip will appear.

• dijit.Tooltip.position

  • type

    String[]

  • summary

    See description of <code>dijit.Tooltip.defaultPosition</code> for details on position parameter.

• dijit.Tooltip._setConnectIdAttr

  • parameters:
    • newId: (typeof String)
  • summary

    Connect to node(s) (specified by id)

  • type

    Function

• dijit.Tooltip._connections

  • type

    Object

• dijit.Tooltip._connectIds

• dijit.Tooltip.addTarget

  • parameters:
    • node: (typeof DOMNODE)

      || String

  • summary

    Attach tooltip to specified node if it's not already connected

  • type

    Function

• dijit.Tooltip.removeTarget

  • parameters:
    • node: (typeof DOMNODE)

      || String

  • summary

    Detach tooltip from specified node

  • type

    Function

• dijit.Tooltip.buildRendering

  • type

    Function

• dijit.Tooltip.startup

  • type

    Function

• dijit.Tooltip._onTargetMouseEnter

  • parameters:
    • e: (typeof Event)
  • summary

    Handler for mouseenter event on the target node

  • tags:
  • type

    Function

• dijit.Tooltip._onTargetMouseLeave

  • parameters:
    • e: (typeof Event)
  • summary

    Handler for mouseleave event on the target node

  • tags:
  • type

    Function

• dijit.Tooltip._onTargetFocus

  • parameters:
    • e: (typeof Event)
  • summary

    Handler for focus event on the target node

  • tags:
  • type

    Function

• dijit.Tooltip._focus

  • type

    bool

• dijit.Tooltip._onTargetBlur

  • parameters:
    • e: (typeof Event)
  • summary

    Handler for blur event on the target node

  • tags:
  • type

    Function

• dijit.Tooltip._onHover

  • parameters:
    • e: (typeof Event)
  • summary

    Despite the name of this method, it actually handles both hover and focus
    events on the target node, setting a timer to show the tooltip.

  • tags:
  • type

    Function

• dijit.Tooltip._showTimer

  • type

    Object

• dijit.Tooltip._onUnHover

  • parameters:
    • e: (typeof Event)
  • summary

    Despite the name of this method, it actually handles both mouseleave and blur
    events on the target node, hiding the tooltip.

  • tags:
  • type

    Function

• dijit.Tooltip.open

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

    Display the tooltip; usually not called directly.

  • tags:
  • type

    Function

• dijit.Tooltip._connectNode

• dijit.Tooltip.close

  • summary

    Hide the tooltip or cancel timer for show of tooltip

  • tags:
  • type

    Function

• dijit.Tooltip.onShow

  • parameters:
    • target
    • position
  • summary

    Called when the tooltip is shown

  • tags: callback
  • type

    Function

• dijit.Tooltip.onHide

  • summary

    Called when the tooltip is hidden

  • tags: callback
  • type

    Function

• dijit.Tooltip.uninitialize

  • type

    Function

• dijit.showTooltip

  • parameters:
    • innerHTML: (typeof String)
    • aroundNode: (typeof DomNode)
    • position: (typeof String[])
    • rtl: (typeof Boolean)
  • summary

    Display tooltip w/specified contents in specified position.
    See description of dijit.Tooltip.defaultPosition for details on position parameter.
    If position is not specified then dijit.Tooltip.defaultPosition is used.

  • type

    Function

• dijit._masterTT

  • type

    Object

• dijit.hideTooltip

  • parameters:
    • aroundNode
  • summary

    Hide the tooltip

  • type

    Function

• dijit.Tooltip.defaultPosition

  • type

    Array

• dijit

  • type

    Object