dojox/widget/Toaster.js

• Provides:

  • dojox.widget.Toaster

• Requires:

  • dojo.fx in common
  • dojo.window in common
  • dijit._Widget in common
  • dijit._Templated in common

• dojox.widget.Toaster

  • type

    Function

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

    Message that slides in from the corner of the screen, used for notifications
    like "new email".

• dojox.widget.Toaster.templateString

  • type

    String

• dojox.widget.Toaster.messageTopic

  • type

    String

  • summary

    Name of topic; anything published to this topic will be displayed as a message.
    Message format is either String or an object like
    {message: "hello word", type: "error", duration: 500}

• dojox.widget.Toaster.messageTypes

  • type

    Enumeration

  • summary

    Possible message types.

• dojox.widget.Toaster.messageTypes.MESSAGE

  • type

    String

• dojox.widget.Toaster.messageTypes.WARNING

  • type

    String

• dojox.widget.Toaster.messageTypes.ERROR

  • type

    String

• dojox.widget.Toaster.messageTypes.FATAL

  • type

    String

• dojox.widget.Toaster.defaultType

  • type

    String

  • summary

    If message type isn't specified (see "messageTopic" parameter),
    then display message as this type.
    Possible values in messageTypes enumeration ("message", "warning", "error", "fatal")

• dojox.widget.Toaster.positionDirection

  • type

    String

  • summary

    Position from which message slides into screen, one of
    ["br-up", "br-left", "bl-up", "bl-right", "tr-down", "tr-left", "tl-down", "tl-right"]

• dojox.widget.Toaster.positionDirectionTypes

  • type

    Array

  • summary

    Possible values for positionDirection parameter

• dojox.widget.Toaster.duration

  • type

    Integer

  • summary

    Number of milliseconds to show message

• dojox.widget.Toaster.slideDuration

  • type

    Integer

  • summary

    Number of milliseconds for the slide animation, increasing will cause the Toaster
    to slide in more slowly.

• dojox.widget.Toaster.separator

  • type

    String

  • summary

    String used to separate messages if consecutive calls are made to setContent before previous messages go away

• dojox.widget.Toaster.postCreate

  • type

    Function

• dojox.widget.Toaster._handleMessage

  • parameters:
    • message: (typeof String|Object)
  • type

    Function

• dojox.widget.Toaster._capitalize

  • parameters:
    • w: (typeof String)
  • type

    Function

• dojox.widget.Toaster.setContent

  • parameters:
    • message: (typeof String|Function)

      the message. If this is a function, it will be called with this toaster widget as the only argument.

    • messageType: (typeof String)

      type of message; possible values in messageTypes enumeration ("message", "warning", "error", "fatal")

    • duration: (typeof int)

      duration in milliseconds to display message before removing it. Widget has default value.

  • summary

    sets and displays the given message and show duration

  • type

    Function

• dojox.widget.Toaster.containerNode.style

• dojox.widget.Toaster.containerNode.style.left

  • type

    String

• dojox.widget.Toaster.containerNode.style.top

  • type

    String

• dojox.widget.Toaster.slideAnim

  • type

    Object

• dojox.widget.Toaster.setContent.duration

  • type

    duration

  • summary

    in milliseconds to display message before removing it. Widget has default value.

• dojox.widget.Toaster._setContent

  • parameters:
    • message
  • type

    Function

• dojox.widget.Toaster.contentNode.innerHTML

• dojox.widget.Toaster._cancelHideTimer

  • type

    Function

• dojox.widget.Toaster._hideTimer

  • type

    Object

• dojox.widget.Toaster._setHideTimer

  • parameters:
    • duration
  • type

    Function

• dojox.widget.Toaster._stickyMessage

  • type

    Object

• dojox.widget.Toaster._placeClip

  • type

    Function

• dojox.widget.Toaster.clipNode.style

• dojox.widget.Toaster.clipNode.style.height

  • type

    String

• dojox.widget.Toaster.clipNode.style.width

  • type

    String

• dojox.widget.Toaster.clipNode.style.top

  • type

    String

• dojox.widget.Toaster.clipNode.style.left

  • type

    String

• dojox.widget.Toaster.clipNode.style.clip

  • type

    String

• dojox.widget.Toaster.clipNode.id

  • type

    Object

• dojox.widget.Toaster.bgIframe

  • type

    Object

• dojox.widget.Toaster.bgIframe.iframe

• dojox.widget.Toaster.bgIframe.iframe.style.display

  • type

    String

• dojox.widget.Toaster.onSelect

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

    callback for when user clicks the message

  • type

    Function

• dojox.widget.Toaster.show

  • summary

    show the Toaster

  • type

    Function

• dojox.widget.Toaster._scrollConnected

  • type

    bool

• dojox.widget.Toaster.hide

  • summary

    hide the Toaster

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object