dojox/image/LightboxNano.js

• Provides:

  • dojox.image.LightboxNano

• Requires:

  • dojo.fx in common

• dojox.image.LightboxNano

  • type

    Function

  • parameters:
    • p: (typeof Object)
    • n: (typeof DomNode)
  • summary

    A simple "nano" version of the lightbox.

  • description

    Very lightweight lightbox which only displays a larger image.  There is
    no support for a caption or description.  The lightbox can be closed by
    clicking any where or pressing any key.  This widget is intended to be
    used on <a> and <img> tags.  Upon creation, if the domNode is <img> tag,
    then it is wrapped in an <a> tag, then a <div class="enlarge"> is placed
    inside the <a> and can be styled to display an icon that the original
    can be enlarged.

  • example

    	<a dojoType="dojox.image.LightboxNano" href="/path/to/largeimage.jpg"><img src="/path/to/thumbnail.jpg"></a>

  • example

    	<img dojoType="dojox.image.LightboxNano" src="/path/to/thumbnail.jpg" href="/path/to/largeimage.jpg">

• dojox.image.LightboxNano.href

  • type

    string

  • summary

    URL to the large image to show in the lightbox.

• dojox.image.LightboxNano.duration

  • type

    int

  • summary

    The delay in milliseconds of the LightboxNano open and close animation.

• dojox.image.LightboxNano.preloadDelay

  • type

    int

  • summary

    The delay in milliseconds after the LightboxNano is created before preloading the larger image.

• dojox.image.LightboxNano.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • p: (typeof Object)
    • n: (typeof DomNode)
  • summary

    Initializes the DOM node and connect onload event

• dojox.image.LightboxNano.destroy

  • summary

    Destroys the LightboxNano and it's DOM node

  • type

    Function

• dojox.image.LightboxNano._connects

  • type

    Array

• dojox.image.LightboxNano._createDiv

  • parameters:
    • cssClass: (typeof String)
    • refNode: (typeof DomNode)
    • display: (typeof boolean)
  • returns

    DomNode

  • summary

    Creates a div for the enlarge icon and loading indicator layers

  • type

    Function

• dojox.image.LightboxNano._load

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

    Creates the large image and begins to show it

  • type

    Function

• dojox.image.LightboxNano._hideLoading

  • summary

    Hides the animated loading indicator

  • type

    Function

• dojox.image.LightboxNano._loadingNode

  • type

    bool

• dojox.image.LightboxNano._show

  • summary

    The image is now loaded, calculate size and display

  • type

    Function

• dojox.image.LightboxNano._sizeBg

  • summary

    Resize the background to fill the page

  • type

    Function

• dojox.image.LightboxNano._key

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

    A key was pressed, so hide the lightbox

  • type

    Function

• dojox.image.LightboxNano._coords

  • parameters:
    • s: (typeof Object)
    • e: (typeof Object)
  • returns

    Object

  • summary

    Returns animation parameters with the start and end coords

  • type

    Function

• dojox.image.LightboxNano._hide

  • summary

    Closes the lightbox

  • type

    Function

• dojox.image.LightboxNano._reset

  • summary

    Destroys the lightbox

  • type

    Function

• dojox.image.LightboxNano._img

  • type

    Object

• dojox.image.LightboxNano._bg

  • type

    Object

• dojox.image.LightboxNano._anim

  • parameters:
    • node: (typeof DomNode)
    • args: (typeof Object)
    • onEnd: (typeof Function)
  • returns

    dojo.Animation

  • summary

    Creates the lightbox open/close and background fadein/out animations

  • type

    Function

• dojox.image.LightboxNano.show

  • parameters:
    • args: (typeof Object)

      An object with optional members of <code>href</code> and <code>origin</code>.
      <code>origin</code> can be be a String|Id of a DomNode to use when
      animating the openeing of the image (the 'box' effect starts
      from this origin point. eg: { origin: e.target })
      If there's no origin, it will use the center of the viewport.
      The <code>href</code> member is a string URL for the image to be
      displayed. Omiting either of these members will revert to
      the default href (which could be absent in some cases) and
      the original srcNodeRef for the widget.

  • summary

    Shows this LightboxNano programatically. Allows passing a new href and
    a programatic origin.

  • type

    Function

• dojox.image.LightboxNano._node

  • type

    Object

• abs

  • type

    String

• vis

  • type

    String

• getViewport

  • summary

    Returns the dimensions and scroll position of the viewable area of a browser window

  • type

    Function

• dojox.image

  • type

    Object

• dojox

  • type

    Object