frame.js revision b909d10cf34b5de748b5324ab34c987f9a601449
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * Creates a wrapper around an iframe. It loads the content either from a local
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * file or from script and creates a local YUI instance bound to that new window and document.
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @module editor
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @submodule frame
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * Creates a wrapper around an iframe. It loads the content either from a local
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * file or from script and creates a local YUI instance bound to that new window and document.
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @class Frame
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @for Frame
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @extends Base
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @constructor
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass var Frame = function() {
e0b25dbc0322a078f384c45b48e5690f23d7eb15Dav Glass Frame.superclass.constructor.apply(this, arguments);
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @property _ready
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @description Internal reference set when the content is ready.
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @type Boolean
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @property _rendered
762b21413a7bbc38b5c7b2d94385fb44f26f9d39Dav Glass * @description Internal reference set when render is called.
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @type Boolean
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @property _iframe
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @description Internal Node reference to the iFrame or the window
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @type Node
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @property _instance
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @description Internal reference to the YUI instance bound to the iFrame or window
e0b25dbc0322a078f384c45b48e5690f23d7eb15Dav Glass * @method _create
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @description Create the iframe or Window and get references to the Document & Window
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @return {Object} Hash table containing references to the new Document & Window
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass extra_css = ((this.get('extracss')) ? '<style id="extra_css">' + this.get('extracss') + '</style>' : '');
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass }, null, true);
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @method _resolveWinDoc
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @description Resolves the document and window from an iframe or window instance
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @param {Object} c The YUI Config to add the window and document to
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @return {Object} Object hash of window and document references, if a YUI config was passed, it is returned.
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass _resolveWinDoc: function(c) {
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass var config = (c) ? c : {};
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass config.win = Y.Node.getDOMNode(this._iframe.get('contentWindow'));
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass config.doc = Y.Node.getDOMNode(this._iframe.get('contentWindow.document'));
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @method _onDomEvent
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @description Generic handler for all DOM events fired by the iframe or window. This handler
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * takes the current EventFacade and augments it to fire on the Frame host. It adds two new properties
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * to the EventFacade called frameX and frameY which adds the scroll and xy position of the iframe
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * to the original pageX and pageY of the event so external nodes can be positioned over the frame.
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @param {Event.Facade} e
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass _onDomEvent: function(e) {
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass e.frameX = xy[0] + e.pageX - node.get('scrollLeft');
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass e.frameY = xy[1] + e.pageY - node.get('scrollTop');
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass initializer: function() {
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass destructor: function() {
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @method _DOMPaste
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @description Simple pass thru handler for the paste event so we can do content cleanup
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @param {Event.Facade} e
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass _DOMPaste: function(e) {
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass // Verify failure
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass getData: function() {
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @method _defReadyFn
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass * @description Binds DOM events, sets the iframe to visible and fires the ready event
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass _defReadyFn: function() {
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass //Y.each(inst.Node.DOM_EVENTS, function(v, k) {
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass if (v === 1) {
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass if (k !== 'focus' && k !== 'blur' && k !== 'paste') {
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass inst.on('paste', Y.bind(this._DOMPaste, this), inst.one('body'));
84e4fc4350d23a4c37b8d6a3f5ee4c131cacf5ddDav Glass //Adding focus/blur to the window object
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @method _onContentReady
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @description Called once the content is available in the frame/window and calls the final use call
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * on the internal instance so that the modules are loaded properly.
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass _onContentReady: function(e) {
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass if (!this._ready) {
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass this._ready = true;
e0b25dbc0322a078f384c45b48e5690f23d7eb15Dav Glass //TODO Circle around and deal with CSS loading...
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass inst.one('doc').get('documentElement').addClass('yui-js-enabled');
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @method _resolveBaseHref
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @description Resolves the basehref of the page the frame is created on. Only applies to dynamic content.
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @param {String} href The new value to use, if empty it will be resolved from the current url.
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @return {String}
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass if (href.indexOf('?') !== -1) { //Remove the query string
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass href = href.substring(0, href.lastIndexOf('/')) + '/';
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @method _getHTML
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @description Get the content from the iframe
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @param {String} html The raw HTML from the body of the iframe.
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @return {String}
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @method _setHTML
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @description Set the content of the iframe
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @param {String} html The raw HTML to set the body of the iframe to.
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @return {String}
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass //This needs to be wrapped in a contentready callback for the !_ready state
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass this.on('contentready', Y.bind(function(html, e) {
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @method _setExtraCSS
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @description Set's the extra CSS on the instance..
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass inst.one('head').append('<style id="extra_css">' + css + '</style>');
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @method _instanceLoaded
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @description Called from the first YUI instance that sets up the internal instance.
d9925fd17da1983ab7b360768676d6253d831a86Dav Glass * This loads the content into the window/frame and attaches the contentready event.
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @param {YUI} inst The internal YUI instance bound to the frame/window
d9925fd17da1983ab7b360768676d6253d831a86Dav Glass //Force other browsers into non CSS styling
d9925fd17da1983ab7b360768676d6253d831a86Dav Glass doc.execCommand('insertbronreturn', false, false);
d9925fd17da1983ab7b360768676d6253d831a86Dav Glass } catch (err) {}
d9925fd17da1983ab7b360768676d6253d831a86Dav Glass //BEGIN PUBLIC METHODS
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @method use
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * @description This is a scoped version of the normal YUI.use method & is bound to this frame/window.
55b12015bcdecf19f771f5387bc9b14af54da374Dav Glass * At setup, the inst.use method is mapped to this method.
008f8a72828325c3326b73e5d40abef1cdac4896Dav Glass use: function() {
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @method delegate
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @description A delegate method passed to the instance's delegate method
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @param {String} type The type of event to listen for
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @param {Function} fn The method to attach
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @param {String} cont The container to act as a delegate, if no "sel" passed, the body is assumed as the container.
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @param {String} sel The selector to match in the event (optional)
dc8b2d1d3b1cfe4b6971da2344e7f77671b4e553Dav Glass * @return {EventHandle} The Event handle returned from Y.delegate
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass return false;
0db84e0da684308b0fd9ea9b5906c11bafa7a246Dav Glass * @method getInstance
d9925fd17da1983ab7b360768676d6253d831a86Dav Glass * @description Get a reference to the internal YUI instance.
d9925fd17da1983ab7b360768676d6253d831a86Dav Glass * @return {YUI} The internal YUI instance
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass getInstance: function() {
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @method render
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @description Render the iframe into the container config option or open the window.
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @param {String/HTMLElement/Node} node The node to render to
fc2d50365b169f761de7a15d7a4fe406b33fd403Dav Glass * @return {Y.Frame}
6a6a6d5448f8c49592581707a20e891abe577bfaDav Glass * @chainable
if (this._rendered) {
this._rendered = true;
if (node) {
this._instanceLoaded(i);
config = {
debug: false,
if (timer) {
fn();
fn();
fn();
} catch (ferr) {
show: function() {
this.focus();
hide: function() {
DOM_EVENTS: {
DEFAULT_CSS: 'html { height: 95%; } body { padding: 7px; background-color: #fff; font: 13px/1.22 arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small; } a, a:visited, a:hover { color: blue !important; text-decoration: underline !important; cursor: text !important; } img { cursor: pointer !important; border: none; }',
//DEFAULT_CSS: 'html { } body { margin: -15px 0 0 -15px; padding: 7px 0 0 15px; display: block; background-color: #fff; font: 13px/1.22 arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small; }',
//DEFAULT_CSS: 'html { height: 95%; } body { height: 100%; padding: 7px; margin: 0 0 0 -7px; postion: relative; background-color: #fff; font: 13px/1.22 arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small; } a, a:visited, a:hover { color: blue !important; text-decoration: underline !important; cursor: text !important; } img { cursor: pointer !important; border: none; }',
//DEFAULT_CSS: 'html { margin: 0; padding: 0; border: none; border-size: 0; } body { height: 97%; margin: 0; padding: 0; display: block; background-color: gray; font: 13px/1.22 arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small; }',
HTML: '<iframe border="0" frameBorder="0" marginWidth="0" marginHeight="0" leftMargin="0" topMargin="0" allowTransparency="true" width="100%" height="99%"></iframe>',
PAGE_HTML: '<html dir="{DIR}" lang="{LANG}"><head><title>{TITLE}</title>{META}<base href="{BASE_HREF}"/><style id="editor_css">{DEFAULT_CSS}</style>{EXTRA_CSS}</head><body>{CONTENT}</body></html>',
* @description The DOCTYPE to prepend to the new document when created. Should match the one on the page being served.
DOC_TYPE: '<!DOCTYPE HTML PUBLIC "-/'+'/W3C/'+'/DTD HTML 4.01/'+'/EN" "http:/'+'/www.w3.org/TR/html4/strict.dtd">',
META: '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7">',
ATTRS: {
title: {
dir: {
lang: {
src: {
designMode: {
writeOnce: true,
value: false
content: {
basehref: {
value: false,
* @description Array of modules to include in the scoped YUI instance at render time. Default: ['none', 'selector-css2']
use: {
writeOnce: true,
* @type String/HTMLElement/Node
container: {
setter: function(n) {
return Y.one(n);
id: {
writeOnce: true,
if (!id) {
return id;
extracss: {
host: {
value: false