Client Framework API

Namespace: OrionLightbox

OrionLightbox

Gives Starlets the ability to open lightboxes.

Source:

Methods

<static> close(starletName)

Closes the lightbox called starletName.

Parameters:
Name Type Description
starletName String

Framework name of Starlet in lightbox.
Source:
See:

<static> closeSelf()

Call from within a lightbox to close itself, regardless of Starlet name.

Source:
See:

<static> open(starletName, url, width, height)

Opens a lightbox called starletName using the criteria provided. The lightbox will appear and remain centered in the main application window. You are responsible for resizing the lightbox if desired.

Parameters:
Name Type Description
starletName String

Desired Framework name of new Starlet.
url String

Location to load in lightbox.
width Number

Desired width of lightbox (px).
height Number

Desired height of lightbox (px).
Source:
See:

<static> setClosedCallback(objectName, callbackName)

Sets a callback to alert you when a lightbox has closed.

Parameters:
Name Type Argument Default Description
objectName String <optional>
 'window'

Namespace containing method.
callbackName String

Name of method.
Source:
See:
Fires:
Example
OrionLightbox.setClosedCallback('', 'closedCallback');

function closedCallback(event)
{
   if (event.eventName == 'lightboxClosed')
   {
       var lightboxName = event.name;
       
       // ...
   }
}