dijit/DialogUnderlay.js

  • Provides:

    • dijit.DialogUnderlay

  • dijit.DialogUnderlay

    • type
      Function
    • chains:
      • dijit._Widget: (prototype)
      • dijit._Widget: (call)
      • dijit._Templated: (call)
    • mixins:
      • dijit._Templated.prototype: (prototype)
    • summary
      The component that blocks the screen behind a `dijit.Dialog`

  • dijit.DialogUnderlay.templateString

    • summary
  • dijit.DialogUnderlay.dialogId
       
    • type
      String
    • summary
      Id of the dialog.... DialogUnderlay's id is based on this id
  • dijit.DialogUnderlay.class
       
    • type
      String
    • summary
      This class name is used on the DialogUnderlay node, in addition to dijitDialogUnderlay
  • dijit.DialogUnderlay.attributeMap
       
    • type
      Object
    • summary
  • dijit.DialogUnderlay._setDialogIdAttr
       
    • type
      Function
    • parameters: 
      • id: (typeof )
    • source: [view] 
                    
      

                       dojo.attr(this.node, "id", id + "_underlay");
         this._set("dialogId", id);
                    
      
                    
    • summary
  • dijit.DialogUnderlay._setClassAttr
       
    • type
      Function
    • parameters: 
      • clazz: (typeof )
    • source: [view] 
                    
      

                       this.node.className = "dijitDialogUnderlay " + clazz;
         this._set("class", clazz);
                    
      
                    
    • summary
  • dijit.DialogUnderlay.postCreate
       
    • type
      Function
    • source: [view] 
                    
      

                       dojo.body().appendChild(this.domNode);
                    
      
                    
    • summary
      Append the underlay to the body
  • dijit.DialogUnderlay.layout
       
    • type
      Function
    • source: [view] 
                    
      

                       var is = this.node.style,
          os = this.domNode.style;


         // hide the background temporarily, so that the background itself isn't
         // causing scrollbars to appear (might happen when user shrinks browser
         // window and then we are called to resize)
         os.display = "none";


         // then resize and show
         var viewport = dojo.window.getBox();
         os.top = viewport.t + "px";
         os.left = viewport.l + "px";
         is.width = viewport.w + "px";
         is.height = viewport.h + "px";
         os.display = "block";
                    
      
                    
    • summary
      Sets the background to the size of the viewport
    • description
      Sets the background to the size of the viewport (rather than the size
of the document) since we need to cover the whole browser window, even
if the document is only a few lines long.
    • tags: 
  • dijit.DialogUnderlay.show
       
    • type
      Function
    • source: [view] 
                    
      

                       this.domNode.style.display = "block";
         this.layout();
         this.bgIframe = new dijit.BackgroundIframe(this.domNode);
                    
      
                    
    • summary
      Show the dialog underlay
  • dijit.DialogUnderlay.hide
       
    • type
      Function
    • source: [view] 
                    
      

                       this.bgIframe.destroy();
         delete this.bgIframe;
         this.domNode.style.display = "none";
                    
      
                    
    • summary
      Hides the dialog underlay
  • dijit.DialogUnderlay.attributeMap.id
       
    • summary
  • dijit.DialogUnderlay.node.className
       
    • summary
  • dijit.DialogUnderlay.domNode.style.display
       
    • summary
  • dijit.DialogUnderlay.bgIframe
       
    • summary
  • dijit
       
    • type
      Object
    • summary