Documentation for a historical release of Infusion: 1.4
Please view the Infusion Documentation site for the latest documentation, or the Infusion 1.3. Documentation for the previous release.
If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.

Render IFrame

Owned by Anastasia Cheetham
Last updated: Sept 09, 2011 by Cindy LiVersion comment

The Render IFrame component is used by the Fat Panel UI Options component to create an iFrame for the UI Options control at the top of the page.

Do not use this component directly. The information on this page should be use when customizing the Fat Panel UI Options.

See Also

Fat Panel UI Options
Full Page UI Options (with Preview)
Full Page UI Options
UI Enhancer

#Supported Events

#afterRender
Fires once the content of the iFrame is loaded.

Methods

none

#Options

listeners
See #Supported Events for information.

#markupProps
An map of attributes, events, and methods to call on the iframe.

#prefix
A relative path to templates.

styles
See below.

#Styles

#container
...

#containerFlex
...

Supported Events

back to top

Listeners can be attached to any supported events through a component's listeners option. Values can be a function reference (not a string function name) or an anonymous function definition, as illustrated below:

var myComponent = component.name("#myContainerID", {
    listeners: {
        eventName1: functionName,
        eventName2: function (params) {
            ...
        }
    }
});

For information on the different types of events, see Infusion Event System.

afterRender

Description

This event fires once the content of the irrame is loaded. This triggers the creation of the sliding panel used to container the iframe

Type

default

Parameters

none

Availability

Infusion 1.4 and later

See also

Sliding Panel

Options

back to top

The second argument to the creator function is the options argument. This is a JavaScript object containing name/value pairs: The name is the name of the option and the value is the desired setting. Components define their own default values for options, but integrators can override these defaults by providing new values using the options argument. For technical information about how options are merged with defaults, see Options Merging.

markupProps

Description

An map of attributes, events, and methods to call on the iframe. The defaults add a class and a style, as well as defining the source for the iFrame.

Default

 
markupProps: {
    style: "overflow-x:hidden; overflow-y:auto;",
    "class": "flc-iframe",
    src: "%prefix/uiOptionsIframe.html"
}

Example

 
markupProps: {
    src: "%prefix/customIframe.html"
}

prefix

Description

The prefix option allows you to specify a custom relative path to the content of the iframe.

Default

"./"

Example

 
prefix: "../templates/"

styles

Description

A JavaScript object...

Default

 
styles: {
    containerFlex: "fl-container-flex",
    container: "fl-uiOptions-fatPanel-iframe"
}

Example

 
styles: {
    containerFlex: "fl-container-flex",
    container: "fl-uiOptions-fatPanel-iframe"
}

See also

 

Styles

container

Description

...

Default

"fl-uiOptions-fatPanel-iframe"

Example

 
styles: {
    container: "prefs-iframe"
}

See also

 

containerFlex

Description

...

Default

"fl-container-flex"

Example

 
styles: {
    containerFlex: "clear-both-css"
}

See also