Module: wcIFrame

Source:

Members


var $iFrame

The iFrame element.

Type:
Source:

Methods


<static> function constructor(container, parent)

Parameters:
Name Type Description
container external:jQuery~selector | external:jQuery~Object | external:domNode A container element for this layout.
parent module:wcPanel The iframes's parent panel.
Source:

function destroy()

Destroys the iFrame element and clears all references.
Note: This is automatically called when the owner panel is destroyed.

Source:

function hide()

Forces the iFrame to be hidden, regardless of whether the panel is visible.

Source:

function onClosed(onClosedFunc)

Registers an event handler when the iFrame has been closed.

Parameters:
Name Type Description
onClosedFunc function A function to call when the iFrame has closed.
Source:

function onLoaded(onLoadedFunc)

Registers an event handler when the contents of this iFrame has loaded.

Parameters:
Name Type Description
onLoadedFunc function A function to call when the iFrame has loaded.
Source:

function openHTML(html)

Populates the iFrame with the given HTML source code using the document to write data.

Parameters:
Name Type Description
html String The HTML source code.
Source:

function openSRC(html)

Populates the iFrame with the given HTML source code using the srcdoc attribute.

Parameters:
Name Type Description
html String The HTML source code.
Version:
  • 3.0.0
Source:

function openURL(url)

Opens a given URL address into the iFrame.

Parameters:
Name Type Description
url String The full, or relative, path to the page.
Source:

function show()

Allows the iFrame to be visible when the panel is visible.

Source:

function window() -> Object

Retrieves the window object from the iFrame element.

Source:
Returns:
- The window object.
Type
Object