dojox/widget/UpgradeBar.js

• Provides:

  • dojox.widget.UpgradeBar

• Requires:

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

• dojox.widget.UpgradeBar

  • type

    Function

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

    Shows a bar at the top of the screen when the user is to
    be notified that they should upgrade their browser or a
    plugin.

  • description

    You can insert custom validations to trigger the UpgradeBar
    to display. An evaluation of 'true' shows the bar (as this
    version *is* less than it should be). Multiple validations
    may be checked, although only the first in the list will be
    displayed.
    Markup and programmatic are supported. Markup is a little
    cleaner, since a majority of the parameters are the HTML
    snippets to be displayed. In markup, the validate code should
    be an expression that will evaluate to true or false. This
    expression is wrapped in a try/catch, so if it blows up, it
    is assumed to be true and trigger the bar.
    In programmtic, a function should be used that returns true
    or false. You would need to use your own try/catch in that.

  • example

    See tests for examples.

• dojox.widget.UpgradeBar.notifications

  • type

    Array

  • summary

    An array of objects that hold the criteria for upgrades.
    message: String
    The message to display in the bar. Can be HTML.
    validate:Function
    The expression to evaluate to determine if the
    bar should show or not. Should be a simple expression
    if used in HTML:
    	<div validate="!google.gears">
    	<div validate="dojo.isIE<8">

• dojox.widget.UpgradeBar.buttonCancel

  • type

    String

  • summary

    The HTML tip show when hovering over the close button.

• dojox.widget.UpgradeBar.noRemindButton

  • type

    String

  • summary

    The text link shown that when clicked, permanently dismisses
    the message (sets a cookie). If this string is blank, this
    link is not displayed.

• dojox.widget.UpgradeBar.templateString

  • type

    Object

• dojox.widget.UpgradeBar.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • props
    • node

• dojox.widget.UpgradeBar.checkNotifications

  • summary

    Internal. Go through the notifications Array
    and check for any that evaluate to true.

  • tags:
  • type

    Function

• dojox.widget.UpgradeBar.postCreate

  • type

    Function

• dojox.widget.UpgradeBar.notify

  • parameters:
    • msg
  • summary

    Triggers the bar to display. An internal function,
    but could ne called externally for fun.

  • tags:
  • type

    Function

• dojox.widget.UpgradeBar.show

  • summary

    Internal. Shows the bar. Do not call directly.
    Use notify();

  • tags:
  • type

    Function

• dojox.widget.UpgradeBar._bodyMarginTop

  • type

    Object

• dojox.widget.UpgradeBar._size

• dojox.widget.UpgradeBar._showAnim

  • type

    Object

• dojox.widget.UpgradeBar.hide

  • summary

    Hides the bar. May be called externally.

  • type

    Function

• dojox.widget.UpgradeBar._hideAnim

  • type

    Object

• dojox.widget.UpgradeBar._onDontRemindClick

  • summary

    Called when user clicks the "do not remind" link.

  • tags:
  • type

    Function

• dojox.widget.UpgradeBar._onCloseEnter

  • summary

    Called when user hovers over close icon

  • tags:
  • type

    Function

• dojox.widget.UpgradeBar._onCloseLeave

  • summary

    Called when user stops hovering over close icon

  • tags:
  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object