API Docs for: 3.18.1

Frame Class

Extends Base
Defined in: editor/js/frame.js:2
Module: frame
Parent Module: editor

Creates a wrapper around an iframe. It loads the content either from a local file or from script and creates a local YUI instance bound to that new window and document.

Constructor

Frame

()

Defined in editor/js/frame.js:2

Methods

addAttr

(
  • name
  • config
  • lazy
)
Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:157

Adds an attribute with the provided configuration to the host object.

The config argument object supports the following properties:

value <Any>
The initial value to set on the attribute
valueFn <Function | String>

A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.

valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.

readOnly <boolean>
Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
writeOnce <boolean> or <string>
Whether or not the attribute is "write once". Attributes having writeOnce set to true, can only have their values set once, be it through the default configuration, constructor configuration arguments, or by invoking set.

The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)

setter <Function | String>

The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.

setter can also be set to a string, representing the name of the instance method to be used as the setter function.

getter <Function | String>

The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.

getter can also be set to a string, representing the name of the instance method to be used as the getter function.

validator <Function | String>

The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.

validator can also be set to a string, representing the name of the instance method to be used as the validator function.

lazyAdd <boolean>
Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.

The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.

Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.

Parameters:

  • name String

    The name of the attribute.

  • config Object

    An object with attribute configuration property/value pairs, specifying the configuration for the attribute.

    NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.

  • lazy Boolean

    (optional) Whether or not to add this attribute lazily (on the first call to get/set).

Returns:

Object:

A reference to the host object.

addAttrs

(
  • cfgs
  • values
  • lazy
)
Object chainable

Inherited from AttributeCore: attribute/js/AttributeCore.js:823

Configures a group of attributes, and sets initial values.

NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.

Parameters:

  • cfgs Object

    An object with attribute name/configuration pairs.

  • values Object

    An object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.

  • lazy Boolean

    Whether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.

Returns:

Object:

A reference to the host object.

addTarget

(
  • o
)
chainable

Inherited from EventTarget: event-custom/js/event-facade.js:496

Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.

Events can only bubble if emitFacade is true.

Included in the event-custom-complex submodule.

Parameters:

after

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:812

Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching the subscription

attrAdded

(
  • name
)
Boolean

Inherited from AttributeCore: attribute/js/AttributeCore.js:319

Checks if the given attribute has been added to the host

Parameters:

  • name String

    The name of the attribute to check.

Returns:

Boolean:

true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.

before

()

Inherited from EventTarget: event-custom/js/event-target.js:849

Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.

For DOM and custom events: type, callback, context, 0-n arguments

For methods: callback, object (method host), methodName, context, 0-n arguments

Returns:

detach handle

bubble

(
  • evt
)
Boolean

Inherited from EventTarget: event-custom/js/event-facade.js:554

Propagate an event. Requires the event-custom-complex module.

Parameters:

Returns:

Boolean:

the aggregated return value from Event.Custom.fire

delegate

(
  • type
  • fn
  • cont
  • sel
)
EventHandle

Defined in editor/js/frame.js:565

A delegate method passed to the instance's delegate method

Parameters:

  • type String

    The type of event to listen for

  • fn Function

    The method to attach

  • cont String

    The container to act as a delegate, if no "sel" passed, the body is assumed as the container.

  • sel String

    The selector to match in the event (optional)

Returns:

EventHandle:

The Event handle returned from Y.delegate

destroy

() BaseCore chainable

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:352

Destroy lifecycle method. Invokes destructors for the class hierarchy.

Returns:

BaseCore:

A reference to this object

detach

(
  • type
  • fn
  • context
)
EventTarget

Inherited from EventTarget: event-custom/js/event-target.js:356

Detach one or more listeners the from the specified event

Parameters:

  • type String | Object

    Either the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.

  • fn Function

    The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.

  • context Object

    The custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)

Returns:

EventTarget:

the host

detachAll

(
  • type
)

Inherited from EventTarget: event-custom/js/event-target.js:479

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String

    The type, or name of the event

fire

(
  • type
  • arguments
)
Boolean

Inherited from EventTarget: event-custom/js/event-target.js:673

Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.

The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.

If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.

Parameters:

  • type String | Object

    The type of the event, or an object that contains a 'type' property.

  • arguments Object*

    an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.

Returns:

Boolean:

True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.

focus

(
  • fn
)
Frame chainable

Defined in editor/js/frame.js:712

Set the focus to the iframe

Parameters:

  • fn Function

    Callback function to execute after focus happens

Returns:

Frame:

get

(
  • name
)
Any

Inherited from AttributeCore: attribute/js/AttributeCore.js:331

Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.

Parameters:

  • name String

    The name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g. get("x.y.z"))

Returns:

Any:

The value of the attribute

getAttrs

(
  • attrs
)
Object

Inherited from AttributeCore: attribute/js/AttributeCore.js:780

Gets multiple attribute values.

Parameters:

  • attrs String[] | Boolean

    Optional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.

Returns:

Object:

An object with attribute name/value pairs.

getDocType

() String static

Defined in editor/js/frame.js:864

Parses document.doctype and generates a DocType to match the parent page, if supported. For IE8, it grabs document.all[0].nodeValue and uses that. For IE < 8, it falls back to Frame.DOC_TYPE.

Returns:

String:

The normalized DocType to apply to the iframe

getEvent

(
  • type
  • prefixed
)
CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:793

Returns the custom event of the provided type has been created, a falsy value otherwise

Parameters:

  • type String

    the type, or name of the event

  • prefixed String

    if true, the type is prefixed already

Returns:

CustomEvent:

the custom event or null

getInstance

() YUI

Defined in editor/js/frame.js:586

Get a reference to the internal YUI instance.

Returns:

YUI:

The internal YUI instance

getTargets

()

Inherited from EventTarget: event-custom/js/event-facade.js:523

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

hide

() Frame chainable

Defined in editor/js/frame.js:780

Hide the iframe instance

Returns:

Frame:

init

(
  • cfg
)
BaseCore chainable

Inherited from BaseObservable but overwritten in base/js/BaseCore.js:319

Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.

Parameters:

  • cfg Object

    Object with configuration property name/value pairs

Returns:

BaseCore:

A reference to this object

modifyAttr

(
  • name
  • config
)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:40

Updates the configuration of an attribute which has already been added.

The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute:

readOnly;
writeOnce;
broadcast; and
getter.

Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base).

Parameters:

  • name String

    The name of the attribute whose configuration is to be updated.

  • config Object

    An object with configuration property/value pairs, specifying the configuration properties to modify.

on

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:188

Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.

 this.on("change", this._onChange, this);

Callback functions for events published with emitFacade = true will receive an EventFacade as the first argument (typically named "e"). These callbacks can then call e.preventDefault() to disable the behavior published to that event's defaultFn. See the EventFacade API for all available properties and methods. Subscribers to non-emitFacade events will receive the arguments passed to fire() after the event name.

To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback.

 this.on({
     "attrChange" : this._onAttrChange,
     "change"     : this._onChange
 });

You can also pass an array of event names as the first argument to subscribe to all listed events with the same callback.

 this.on([ "change", "attrChange" ], this._onChange);

Returning false from a callback is supported as an alternative to calling e.preventDefault(); e.stopPropagation();. However, it is recommended to use the event methods whenever possible.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching that subscription

once

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:124

Listen to a custom event hosted by this object one time. This is the equivalent to on except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching the subscription

onceAfter

(
  • type
  • fn
  • [context]
  • [arg*]
)
EventHandle

Inherited from EventTarget: event-custom/js/event-target.js:146

Listen to a custom event hosted by this object one time. This is the equivalent to after except the listener is immediatelly detached when it is executed.

Parameters:

  • type String

    The name of the event

  • fn Function

    The callback to execute in response to the event

  • [context] Object optional

    Override this object in callback

  • [arg*] Any optional

    0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching that subscription

parseType

(
  • type
  • [pre]
)
Array

Inherited from EventTarget: event-custom/js/event-target.js:168

Available since 3.3.0

Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.

Parameters:

  • type String

    the type

  • [pre] String optional

    The prefix. Defaults to this._yuievt.config.prefix

Returns:

Array:

an array containing:

  • the detach category, if supplied,
  • the prefixed event type,
  • whether or not this is an after listener,
  • the supplied event type

publish

(
  • type
  • opts
)
CustomEvent

Inherited from EventTarget: event-custom/js/event-target.js:503

Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.

Parameters:

  • type String

    the type, or name of the event

  • opts Object

    optional config params. Valid properties are:

    • [broadcast=false] Boolean optional

      whether or not the YUI instance and YUI global are notified when the event is fired.

    • [bubbles=true] Boolean optional

      Whether or not this event bubbles. Events can only bubble if emitFacade is true.

    • [context=this] Object optional

      the default execution context for the listeners.

    • [defaultFn] Function optional

      the default function to execute when this event fires if preventDefault was not called.

    • [emitFacade=false] Boolean optional

      whether or not this event emits a facade.

    • [prefix] String optional

      the prefix for this targets events, e.g., 'menu' in 'menu:click'.

    • [fireOnce=false] Boolean optional

      if an event is configured to fire once, new subscribers after the fire will be notified immediately.

    • [async=false] Boolean optional

      fireOnce event listeners will fire synchronously if the event has already fired unless async is true.

    • [preventable=true] Boolean optional

      whether or not preventDefault() has an effect.

    • [preventedFn] Function optional

      a function that is executed when preventDefault() is called.

    • [queuable=false] Boolean optional

      whether or not this event can be queued during bubbling.

    • [silent] Boolean optional

      if silent is true, debug messages are not provided for this event.

    • [stoppedFn] Function optional

      a function that is executed when stopPropagation is called.

    • [monitored] Boolean optional

      specifies whether or not this event should send notifications about when the event has been attached, detached, or published.

    • [type] String optional

      the event type (valid option if not provided as the first parameter to publish).

Returns:

CustomEvent:

the custom event

removeAttr

(
  • name
)

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:90

Removes an attribute from the host object

Parameters:

  • name String

    The name of the attribute to be removed.

removeTarget

(
  • o
)
chainable

Inherited from EventTarget: event-custom/js/event-facade.js:533

Removes a bubble target

Parameters:

render

(
  • node
)
Frame chainable

Defined in editor/js/frame.js:594

Render the iframe into the container config option or open the window.

Parameters:

  • node String/HTMLElement/Node

    The node to render to

Returns:

Frame:

reset

(
  • name
)
Object chainable

Inherited from AttributeExtras: attribute/js/AttributeExtras.js:100

Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.

Parameters:

  • name String

    Optional. The name of the attribute to reset. If omitted, all attributes are reset.

Returns:

Object:

A reference to the host object.

set

(
  • name
  • value
  • [opts]
)
Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:388

Sets the value of an attribute.

Parameters:

  • name String

    The name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g. set("x.y.z", 5)).

  • value Any

    The value to set the attribute to.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

setAttrs

(
  • attrs
  • [opts]
)
Object chainable

Inherited from AttributeObservable but overwritten in attribute/js/AttributeCore.js:747

Sets multiple attribute values.

Parameters:

  • attrs Object

    An object with attributes name/value pairs.

  • [opts] Object optional

    Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

show

() Frame chainable

Defined in editor/js/frame.js:759

Show the iframe instance

Returns:

Frame:

subscribe

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:346

Deprecated: use on

subscribe to an event

toString

() String

Inherited from BaseCore: base/js/BaseCore.js:815

Default toString implementation. Provides the constructor NAME and the instance guid, if set.

Returns:

String:

String representation for this object

unsubscribe

() deprecated

Inherited from EventTarget: event-custom/js/event-target.js:469

Deprecated: use detach

detach a listener

unsubscribeAll

(
  • type
)
deprecated

Inherited from EventTarget: event-custom/js/event-target.js:490

Deprecated: use detachAll

Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.

Parameters:

  • type String

    The type, or name of the event

use

()

Defined in editor/js/frame.js:541

This is a scoped version of the normal YUI.use method & is bound to this frame/window. At setup, the inst.use method is mapped to this method.

Properties

DEFAULT_CSS

String static

Defined in editor/js/frame.js:824

The default css used when creating the document.

DOC_TYPE

String static

Defined in editor/js/frame.js:893

The DOCTYPE to prepend to the new document when created. Should match the one on the page being served.

DOM_EVENTS

Object static

Defined in editor/js/frame.js:802

The DomEvents that the frame automatically attaches and bubbles

HTML

String deprecated static

Defined in editor/js/frame.js:831

The template string used to create the iframe, deprecated to use DOM instead of innerHTML

IFRAME_ATTRS

Object static

Defined in editor/js/frame.js:839

Attributes to auto add to the dynamic iframe under the hood

META

String static

Defined in editor/js/frame.js:900

The meta-tag for Content-Type to add to the dynamic document

NAME

String static

Defined in editor/js/frame.js:908

The name of the class (frame)

name

String deprecated

Inherited from BaseCore: base/js/BaseCore.js:297

Deprecated: Use this.constructor.NAME

The string used to identify the class of this object.

NS

String static

Defined in editor/js/frame.js:915

The namespace on which Frame plugin will reside.

Default: 'frame'

PAGE_HTML

String static

Defined in editor/js/frame.js:856

The template used to create the page when created dynamically.

THROTTLE_TIME

Number static

Defined in editor/js/frame.js:794

The throttle time for key events in IE

Default: 100

Attributes

basehref

String

Defined in editor/js/frame.js:979

The base href to use in the iframe.

Fires event basehrefChange

Fires when the value for the configuration attribute basehref is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

container

String/HTMLElement/Node

Defined in editor/js/frame.js:998

The container to append the iFrame to on render.

Fires event containerChange

Fires when the value for the configuration attribute container is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

content

String

Defined in editor/js/frame.js:968

The string to inject into the body of the new frame/window.

Fires event contentChange

Fires when the value for the configuration attribute content is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

defaultblock

String

Defined in editor/js/frame.js:1055

The default tag to use for block level items, defaults to: p

Fires event defaultblockChange

Fires when the value for the configuration attribute defaultblock is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

designMode

Boolean

Defined in editor/js/frame.js:958

Should designMode be turned on after creation.

Fires event designModeChange

Fires when the value for the configuration attribute designMode is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

destroyed

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:212

Flag indicating whether or not this object has been through the destroy lifecycle phase.

Default: false

Fires event destroyedChange

Fires when the value for the configuration attribute destroyed is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

dir

String

Defined in editor/js/frame.js:933

The default text direction for this new frame. Default: ltr

Fires event dirChange

Fires when the value for the configuration attribute dir is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

extracss

String

Defined in editor/js/frame.js:1046

A string of CSS to add to the Head of the Editor

Fires event extracssChange

Fires when the value for the configuration attribute extracss is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

id

String

Defined in editor/js/frame.js:1021

Set the id of the new Node. (optional)

Fires event idChange

Fires when the value for the configuration attribute id is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

initialized

Boolean readonly

Inherited from BaseCore: base/js/BaseCore.js:198

Flag indicating whether or not this object has been through the init lifecycle phase.

Default: false

Fires event initializedChange

Fires when the value for the configuration attribute initialized is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

lang

String

Defined in editor/js/frame.js:941

The default language. Default: en-US

Fires event langChange

Fires when the value for the configuration attribute lang is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

linkedcss

String | Array

Defined in editor/js/frame.js:1036

An array of url's to external linked style sheets

Fires event linkedcssChange

Fires when the value for the configuration attribute linkedcss is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

node

Node

Defined in editor/js/frame.js:1009

The Node instance of the iframe.

Fires event nodeChange

Fires when the value for the configuration attribute node is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

src

String

Defined in editor/js/frame.js:949

The src of the iframe/window. Defaults to javascript:;

Fires event srcChange

Fires when the value for the configuration attribute src is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

title

String

Defined in editor/js/frame.js:925

The title to give the blank page.

Fires event titleChange

Fires when the value for the configuration attribute title is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

use

Array

Defined in editor/js/frame.js:988

Array of modules to include in the scoped YUI instance at render time. Default: ['none', 'selector-css2']

Fires event useChange

Fires when the value for the configuration attribute use is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

Events

destroy

Inherited from BaseObservable: base/js/BaseObservable.js:163

Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.

Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).

Event Payload:

init

Inherited from BaseObservable: base/js/BaseObservable.js:62

Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.

Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).

Event Payload:

  • e EventFacade

    Event object, with a cfg property which refers to the configuration object passed to the constructor.