dojox/widget/Standby.js

• Provides:

  • dojox.widget.Standby

• Requires:

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

• dojox.widget.Standby

  • type

    Function

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

    A widget designed to act as a Standby/Busy/Disable/Blocking widget to indicate a
    particular DOM node is processing and cannot be clicked on at this time.
    This widget uses absolute positioning to apply the overlay and image.

• dojox.widget.Standby.templateString

  • tags:
  • type

    String

  • summary

    The template string defining out the basics of the widget.  No need for an external
    file.

• dojox.widget.Standby._underlayNode

  • tags:
  • type

    DOMNode

  • summary

    The node that is the translucent underlay for the
    image that blocks access to the target.

• dojox.widget.Standby._imageNode

  • tags:
  • type

    DOMNode

  • summary

    The image node where we attach and define the image to display.

• dojox.widget.Standby._textNode

  • tags:
  • type

    DOMNode

  • summary

    The div to attach text/HTML in the overlay center item.

• dojox.widget.Standby._centerNode

  • tags:
  • type

    DOMNode

  • summary

    Which node to use as the center node, the image or the text node.

• dojox.widget.Standby.image

  • type

    String

  • summary

    The URL to the image to center in the overlay.

• dojox.widget.Standby.imageText

  • type

    String

  • summary

    Text for the ALT tag.

• dojox.widget.Standby.text

  • type

    String

  • summary

    Text/HTML to display in the center of the overlay
    This is used if image center is disabled.

• dojox.widget.Standby.centerIndicator

  • type

    String

  • summary

    Property to define if the image and its alt text should be used, or
    a simple Text/HTML node should be used.  Allowable values are 'image'
    and 'text'.
    Default is 'image'.

• dojox.widget.Standby._displayed

  • tags:
  • type

    Boolean

  • summary

    Flag to indicate if the overlay is displayed or not.

• dojox.widget.Standby._resizeCheck

  • tags:
  • type

    Object

  • summary

    Handle to interval function that checks the target for changes.

• dojox.widget.Standby.target

  • type

    DOMNode||DOMID(String)||WidgetID(String)

  • summary

    The target to overlay when active.  Can be a widget id, a
    dom id, or a direct node reference.

• dojox.widget.Standby.color

  • type

    String

  • summary

    The color to set the overlay.  Should be in #XXXXXX form.
    Default color for the translucent overlay is light gray.

• dojox.widget.Standby.duration

  • type

    integer

  • summary

    Integer defining how long the show and hide effects should take.

• dojox.widget.Standby._started

  • tags:
  • type

    Boolean

  • summary

    Trap flag to ensure startup only processes once.

• dojox.widget.Standby._parent

  • tags:
  • type

    DOMNode

  • summary

    Wrapping div for the widget, also used for IE 7 in dealing with the
    zoom issue.

• dojox.widget.Standby.zIndex

  • type

    String

  • summary

    Control that lets you specify if the zIndex for the overlay
    should be auto-computed based off parent zIndex, or should be set
    to a particular value.  This is useful when you want to overlay
    things in digit.Dialogs, you can specify a base zIndex to append from.

• dojox.widget.Standby.startup

  • parameters:
    • args
  • summary

    Over-ride of the basic widget startup function.
    Configures the target node and sets the image to use.

  • type

    Function

• dojox.widget.Standby._textNode.innerHTML

• dojox.widget.Standby._ieFixNode

  • type

    Object

• dojox.widget.Standby.show

  • summary

    Function to display the blocking overlay and busy/status icon or text.

  • type

    Function

• dojox.widget.Standby.hide

  • summary

    Function to hide the blocking overlay and status icon or text.

  • type

    Function

• dojox.widget.Standby.isVisible

  • returns

    boolean

  • summary

    Helper function so you can test if the widget is already visible or not.

  • return_summary

    boolean indicating if the widget is in 'show' state or not.

  • type

    Function

• dojox.widget.Standby.onShow

  • summary

    Event that fires when the display of the Standby completes.

  • type

    Function

• dojox.widget.Standby.onHide

  • summary

    Event that fires when the display of the Standby completes.

  • type

    Function

• dojox.widget.Standby.uninitialize

  • summary

    Over-ride to hide the widget, which clears intervals, before cleanup.

  • type

    Function

• dojox.widget.Standby._size

  • summary

    Internal function that handles resizing the overlay and
    centering of the image on window resizing.

  • tags:
  • type

    Function

• dojox.widget.Standby.target.parentNode

• dojox.widget.Standby._cloneStyles

  • parameters:
    • list: (typeof Array)

      An array of style names to clone.

  • summary

    Internal function to clone a set of styles from the target to
    the underlay.

  • tags:
  • type

    Function

• dojox.widget.Standby._fadeIn

  • summary

    Internal function that does the opacity style fade in animation.

  • tags:
  • type

    Function

• dojox.widget.Standby._anim

  • type

    Object

• dojox.widget.Standby._fadeOut

  • summary

    Internal function that does the opacity style fade out animation.

  • tags:
  • type

    Function

• dojox.widget.Standby._ignore

  • parameters:
    • event: (typeof Event)

      The event to halt

  • summary

    Function to ignore events that occur on the overlay.

  • tags:
  • type

    Function

• dojox.widget.Standby._scrollerWidths

  • summary

    This function will calculate the size of the vertical and
    horizontaol scrollbars.

  • return_summary

    Object of form: {v: Number, h: Number} where v is vertical scrollbar width
    and h is horizontal scrollbar width.

  • tags:
  • type

    Function

• dojox.widget.Standby._setTextAttr

  • parameters:
    • text: (typeof String)

      The text to set.

  • summary

    Function to allow widget.attr to set the text displayed in center
    if using text display.

  • type

    Function

• dojox.widget.Standby._setTextAttr.text

  • type

    String

  • summary

    The text to set.

• dojox.widget.Standby._setColorAttr

  • parameters:
    • c: (typeof String)

      The color to set the background underlay to in #XXXXXX format..

  • summary

    Function to allow widget.attr to set the color used for the translucent
    div overlay.

  • type

    Function

• dojox.widget.Standby._setImageTextAttr

  • parameters:
    • text: (typeof String)

      The text to set.

  • summary

    Function to allow widget.attr to set the ALT text text displayed for
    the image (if using image center display).

  • type

    Function

• dojox.widget.Standby._setImageAttr

  • parameters:
    • url
  • summary

    Function to allow widget.attr to set the url source for the center image
    text: String
    The url to set for the image.

  • type

    Function

• dojox.widget.Standby._setCenterIndicatorAttr

  • parameters:
    • indicator: (typeof String)

      The indicator to use, either 'image' or 'text'.

  • summary

    Function to allow widget.attr to set the node used for the center indicator,
    either the image or the text.

  • type

    Function

• dojox.widget.Standby._disableOverflow

  • summary

    Function to disable scrollbars on the body.  Only used if the overlay
    targets the body or the document.

  • type

    Function

• dojox.widget.Standby._overflowDisabled

  • type

    Object

• dojox.widget.Standby._oldOverflow

  • type

    String

• dojox.widget.Standby._oldBodyParentOverflow

  • type

    String

• dojox.widget.Standby._enableOverflow

  • summary

    Function to restore scrollbars on the body.  Only used if the overlay
    targets the body or the document.

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object