Editor Class

Uses

Extends Editor.Base

Defined in: src/sm-editor/js/editor.js:10

Module: gallery-sm-editor

A simple but powerful WYSIWYG editor.

Constructor

`Editor`

()

Defined in src/sm-editor/js/editor.js:10

Index
Methods
Properties
Attributes
Events

Item Index

Methods

`_addAttrs`

(

cfgs
values
lazy

)

private

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

Implementation behind the public addAttrs method.

This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).

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.

`_addLazyAttr`

(

name
[lazyCfg]

)

private

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

Finishes initializing an attribute which has been lazily added.

Parameters:

name Object

The name of the attribute
[lazyCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.

`_addOutOfOrder`

(

name
cfg

)

private

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

Utility method used by get/set to add attributes encountered out of order when calling addAttrs().

For example, if:

this.addAttrs({
     foo: {
         setter: function() {
            // make sure this bar is available when foo is added
            this.get("bar");
         }
     },
     bar: {
         value: ...
     }
});

Parameters:

name String

attribute name
cfg Object

attribute configuration

`_afterContainerChange`

() protected

Inherited from View: app/js/view.js:357

Available since 3.5.0

Handles containerChange events. Detaches event handlers from the old container (if any) and attaches them to the new container.

Right now the container attr is initOnly so this event should only ever fire the first time the container is created, but in the future (once Y.App can handle it) we may allow runtime container changes.

`_aggregateAttrs`

(

allAttrs

)

Object private

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

A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.

The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).

Parameters:

allAttrs Array

An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object:

The aggregate set of ATTRS definitions for the instance

`_attachBlockEvents`

() protected

Inherited from Editor.Block: src/sm-editor/js/extensions/editor-block.js:116

Attaches block events.

`_attachEvents`

() protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:294

Attaches editor events.

`_attachKeyEvents`

() protected

Inherited from Editor.Keys: src/sm-editor/js/extensions/editor-keys.js:99

Attaches keyboard events.

`_attachQueueEvents`

() protected

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:72

Attaches queue events.

`_attrCfgHash`

() private

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

Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.

`_baseDestroy`

() private

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

Internal destroy implementation for BaseCore

`_baseInit`

() private

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

Internal initialization implementation for BaseCore

`_blockOnSelectionChange`

(

)

protected

Inherited from Editor.Block: src/sm-editor/js/extensions/editor-block.js:306

Event handler for the selection change event

Creates a default block if none exists for the current selection

Parameters:

e EventFacade

`_clearCommandQueue`

() protected

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:93

Clears the command queue

`_cloneDefaultValue`

(

cfg

)

private

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

This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.

Parameters:

cfg Object

`_createLink`

(

options

)

protected

Inherited from Editor.Link: src/sm-editor/js/extensions/editor-link.js:111

Implementation for the createLink command

Wraps the currently selected range in an anchor <a> tag

Parameters:

options Object
- href String
- [target=_self] String optional
- [text] String optional

`_defAttrChangeFn`

(

e
eventFastPath

)

private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:185

Default function for attribute change events.

Parameters:

e EventFacade

The event object for attribute change events.
eventFastPath Boolean

Whether or not we're using this as a fast path in the case of no listeners or not

`_defDestroyFn`

(

)

protected

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

Default destroy event handler

Parameters:

e EventFacade

Event object

`_defInitFn`

(

)

protected

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

Default init event handler

Parameters:

e EventFacade

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

`_delete`

(

[direction=back]

)

protected

Inherited from Editor.Delete: src/sm-editor/js/extensions/editor-delete.js:78

Handles backspace and delete because webkit is an idiot and will copy computed styles like line-height, color and font-size when merging blocks of different types.

For example given the following HTML:

<h1>foo</h1>
<p>bar</p>

Hitting backspace with the cursor at the beginning of the <p> element will create a <span> in the <h1> after the text foo with the computed styles of the <p> element. The brilliant result is:

<h1>foo<span style="line-height: 1.2; font-size:12px; color:xxx;">bar</span></h1>

Its so stupid and IE/Firefox do not behave this way.

Related, when deleting across blocks with different text-alignment, Firefox will copy text-alignment from the later block, which is opposite of what the other browsers do.

This method normalizes the behavior when deleting across blocks to not copy styles. The result from the previous example is now:

<h1>foobar</h1>

Parameters:

[direction=back] String optional

forward for a forward delete, back for a backspace

`_destroyContainer`

() protected

Inherited from View: app/js/view.js:312

Removes the container from the DOM and purges all its event listeners.

`_destroyHierarchy`

() private

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

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

`_detachBlockEvents`

() protected

Inherited from Editor.Block: src/sm-editor/js/extensions/editor-block.js:133

Detaches block events.

`_detachEvents`

() protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:318

Detaches editor events.

`_detachKeyEvents`

() protected

Inherited from Editor.Keys: src/sm-editor/js/extensions/editor-keys.js:117

Detaches keyboard events.

`_detachQueueEvents`

() protected

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:104

Detaches queue events.

`_execCommand`

(

name
value

)

protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:331

Wrapper for native the native execCommand() that verifies that the command is valid in the current state

Parameters:

name String

Command name.
value Boolean | String

Command value.

`_execStyleCommand`

(

name
value

)

protected

Inherited from Editor.Style: src/sm-editor/js/extensions/editor-style.js:231

Executes a style command by adding/removing css properties

Parameters:

name String

Command name.
value Boolean | String

Command value.

`_filterAdHocAttrs`

(

allAttrs
userVals

)

Object private

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

Parameters:

allAttrs Object

The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.
userVals Object

The config object passed in by the user, from which adhoc attrs are to be filtered.

Returns:

Object:

The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

`_fireAttrChange`

(

attrName
subAttrName
currVal
newVal
opts
[cfg]

)

private

Inherited from AttributeObservable: attribute/js/AttributeObservable.js:120

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

attrName String

The name of the attribute
subAttrName String

The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
currVal Any

The current value of the attribute
newVal Any

The new value of the attribute
opts Object

Any additional event data to mix into the attribute change event's event facade.
[cfg] Object optional

The attribute config stored in State, if already available.

`_flushCommandQueue`

() protected

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:118

Executes all commands on the command queue

`_formatBlock`

(

tag

)

protected

Inherited from Editor.Block: src/sm-editor/js/extensions/editor-block.js:147

Replaces block elements containing the current selection with elements of the given tag

Parameters:

tag String

The new block element tag

`_formatHTML`

(

html

)

Node protected

Inherited from Editor.Format: src/sm-editor/js/extensions/editor-format.js:41

Reformats html to the proper style

TODO: put this in its own extension. doesn't belong here.

Parameters:

html HTML

HTML string to format

Returns:

Node:

Node instance containing a document fragment with the formatted html

`_forwardDelete`

() protected

Inherited from Editor.Delete: src/sm-editor/js/extensions/editor-delete.js:191

Performs a forward delete from the current cursor position

`_getAnchorNode`

() Node protected

Inherited from Editor.Link: src/sm-editor/js/extensions/editor-link.js:94

Returns the nearest ancestor anchor that entirely contains the current range

Returns:

Node:

The containing anchor element

`_getAttr`

(

name

)

Any protected chainable

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

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.

See get for argument details.

Parameters:

name String

The name of the attribute.

Returns:

Any:

The value of the attribute.

`_getAttrCfg`

(

name

)

Object protected

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

Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.

Parameters:

name String

Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

Returns:

Object:

The configuration properties for the given attribute, or all attributes.

`_getAttrCfgs`

() Object protected

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

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object:

The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.

`_getAttrInitVal`

(

attr
cfg
initValues

)

Any private

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

Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.

Parameters:

attr String

The name of the attribute
cfg Object

The attribute configuration object
initValues Object

The object with simple and complex attribute name/value pairs returned from _normAttrVals

Returns:

Any:

The initial value of the attribute.

`_getAttrs`

(

attrs

)

Object protected

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

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

attrs Array | 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.

`_getClasses`

() Function[] protected

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

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function[]:

An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.

`_getContainer`

(

value

)

Node protected

Inherited from View: app/js/view.js:323

Available since 3.5.0

Getter for the container attribute.

Parameters:

value Node | Null

Current attribute value.

Returns:

Node:

Container node.

`_getFullType`

(

type

)

String private

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

Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.

NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.

Parameters:

type String

The short type to prefix

Returns:

String:

The prefixed type, if a prefix is set, otherwise the type passed in

`_getHTML`

(

value

)

HTML protected

Inherited from Editor.Base but overwritten in src/sm-editor/js/extensions/editor-format.js:106

Getter for the html attribute.

Parameters:

value HTML

HTML.

Returns:

HTML:

HTML.

`_getInstanceAttrCfgs`

(

allCfgs

)

Object private

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

A helper method used to isolate the attrs config for this instance to pass to addAttrs, from the static cached ATTRS for the class.

Parameters:

allCfgs Object

The set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.

Returns:

Object:

The set of attributes to be added for this instance, suitable for passing through to addAttrs.

`_getNodes`

(

range
selector

)

NodeList protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:361

Returns nodes containing any part of the given range matching the given selector

Parameters:

range Range
selector String

Returns:

NodeList:

`_getStateVal`

(

name
[cfg]

)

Any private

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

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
[cfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Any:

The stored value of the attribute

`_getStyleNodes`

(

range

)

NodeList protected

Inherited from Editor.Style: src/sm-editor/js/extensions/editor-style.js:281

Parses inline elements from a given range. Partially selected nodes will be split and text nodes will be wrapped in <span> tags if necessary.

Parameters:

range Range

Returns:

NodeList:

NodeList of inline elements within the given range

`_getText`

(

value

)

String protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:414

Getter for the text attribute.

Parameters:

value String

Internal value.

Returns:

String:

Text.

`_getType`

() private

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

If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.

`_hasPotentialSubscribers`

(

fullType

)

Boolean private

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

Parameters:

fullType String

The fully prefixed type name

Returns:

Boolean:

Whether the event has potential subscribers or not

`_initAttrHost`

(

attrs
values
lazy

)

private

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

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

attrs Object

The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values Object

The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy Boolean

Whether or not to add attributes lazily (passed through to addAttrs).

`_initAttribute`

() private

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

Initializes AttributeCore

`_initAttrs`

(

attrs
values
lazy

)

protected

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

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

Parameters:

attrs Object

The attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
values Object

The initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
lazy Boolean

Whether or not to add attributes lazily (passed through to addAttrs).

`_initBase`

(

config

)

private

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

Internal construction logic for BaseCore.

Parameters:

config Object

The constructor configuration object

`_initHierarchy`

(

userVals

)

private

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

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.

Parameters:

userVals Object

Object with configuration property name/value pairs

`_initHierarchyData`

() private

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

A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.

`_insertHTML`

(

html

)

Node protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:426

Inserts the specified html at the current selection point, deleting the current selection if there is one.

Parameters:

html HTML | HTMLElement | Node

HTML to insert, in the form of an HTML string, HTMLElement, or Node instance.

Returns:

Node:

Node instance representing the inserted HTML.

`_insertReturn`

() protected

Inherited from Editor.Block: src/sm-editor/js/extensions/editor-block.js:191

Inserts a return at the current selection point.

Any content contained by the range is deleted, resulting in a collapsed range.

If the range is at the start of a block, a duplicate, empty block is inserted as the previous sibling of current block. The range is positioned at the beginning of the new block

If the range is at the end of a block, a new <p> element is created as the next sibling of the current block. The range is positioned at the start of the new block.

If the range is in the middle of a block, the block will be split at the current position. The range will be positioned at the beginning of the new block.

`_insertTab`

() protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:458

Inserts a <span> at the current selection point containing a preformatted tab character.

`_insertText`

(

text

)

Node protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:469

Inserts the specified plain text at the current selection point, deleting the current selection if there is one.

Parameters:

text String

Text to insert.

Returns:

Node:

Node instance representing the inserted text node.

`_isBlockNode`

(

node

)

Boolean protected

Inherited from Editor.Format: src/sm-editor/js/extensions/editor-format.js:121

Returns true if the given node is a container element, false otherwise A container element is defined as a non-inline element

Parameters:

node HTMLNode | Node

Returns:

Boolean:

true if the given node is a container element, false otherwise

`_isLazyAttr`

(

name

)

Boolean private

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

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

name String

The name of the attribute

Returns:

Boolean:

true if it's a lazily added attribute, false otherwise.

`_isStyleNode`

(

node

)

Boolean protected

Inherited from Editor.Format: src/sm-editor/js/extensions/editor-format.js:139

Returns true if the given node is an inline element node, false otherwise

Parameters:

node HTMLNode | Node

Returns:

Boolean:

true if the given node is an inline element node, false otherwise

`_monitor`

(

what
eventType
o

)

private

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

This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> click_attach, click_detach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.

Parameters:

what String

'attach', 'detach', 'fire', or 'publish'
eventType String | CustomEvent

The prefixed name of the event being monitored, or the CustomEvent object.
o Object

Information about the event interaction, such as fire() args, subscription category, publish config

`_noCommand`

() protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:489

No-op function for allowing default browser implementations.

Use as the commandFn in a command config when the default browser behavior is desired. Allows for the command stack to execute and selection to be updated

`_normAttrVals`

(

valueHash

)

Object private

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

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

Parameters:

valueHash Object

An object with attribute name/value pairs

Returns:

Object:

An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.

`_onBlur`

() protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:593

Handles blur events on the editor.

`_onCopy`

(

)

protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:609

Handles copy events on the editor.

Parameters:

e EventFacade

`_onCut`

(

)

protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:632

Handles cut events on the editor.

Parameters:

e EventFacade

`_onDblClick`

() protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:662

Handles dblclick events on the editor.

`_onFocus`

() protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:674

Handles focus events on the editor.

`_onKeyDown`

(

)

protected

Inherited from Editor.Keys: src/sm-editor/js/extensions/editor-keys.js:132

Handles keydown events on this editor.

Parameters:

e EventFacade

`_onKeyPress`

(

)

protected

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:166

Handles keypress events on the editor

Parameters:

e EventFacade

`_onPaste`

(

)

protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:711

Handles paste events on the editor.

Parameters:

e EventFacade

`_parseType`

() private

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

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

`_preInitEventCfg`

(

config

)

private

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

Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.

Parameters:

config Object

The user configuration object

`_protectAttrs`

(

attrs

)

Object deprecated protected

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

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

attrs Object

A hash of attribute to configuration object pairs.

Returns:

Object:

A protected version of the attrs argument.

`_publish`

(

fullType
etOpts
ceOpts

)

CustomEvent private

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

The low level event publish implementation. It expects all the massaging to have been done outside of this method. e.g. the type to fullType conversion. It's designed to be a fast path publish, which can be used by critical code paths to improve performance.

Parameters:

fullType String

The prefixed type of the event to publish.
etOpts Object

The EventTarget specific configuration to mix into the published event.
ceOpts Object

The publish specific configuration to mix into the published event.

Returns:

CustomEvent:

The published event. If called without etOpts or ceOpts, this will be the default CustomEvent instance, and can be configured independently.

`_queryBlockCommand`

() NodeList protected

Inherited from Editor.Block: src/sm-editor/js/extensions/editor-block.js:258

Default query function for block elements

Returns:

NodeList:

A nodelist of the block nodes containing the range

`_queryCommandValue`

(

name

)

Boolean | String protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:504

Wrapper for the native queryCommandValue() method

Parameters:

name String

Command name.

Returns:

Boolean | String:

Command value.

`_queryStyleCommand`

(

name

)

Boolean | String protected

Inherited from Editor.Style: src/sm-editor/js/extensions/editor-style.js:344

Returns the value of a style command by querying css properties

Parameters:

name String

Command name.

Returns:

Boolean | String:

Boolean style commands will return true/false, other commands will return the property value, or null if the property doesn't exist.

`_queueBeforeExecStyleCommand`

(

name
value

)

protected

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:198

Wrapper for Editor.Base#_execCommand().

Parameters:

name String

Command name.
value Boolean | String

Command value.

`_queueCommand`

() protected

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:141

Adds a command to the queue

`_queueDoBeforeQueryCommandValue`

(

name

)

protected

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:224

Wrapper for Editor.Base#_queryCommandValue().

Parameters:

name String

Command name.

`_set`

(

name
val
[opts]

)

Object protected chainable

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

Allows setting of readOnly/writeOnce attributes. See set for argument details.

Parameters:

name String

The name of the attribute.
val 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.

`_setAttr`

(

name
value
[opts]
force

)

Object protected chainable

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

Provides the common implementation for the public set and protected _set methods.

See set for argument details.

Parameters:

name String

The name of the attribute.
value Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.
force Boolean

If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object:

A reference to the host object.

`_setAttrs`

(

attrs
[opts]

)

Object protected chainable

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

Implementation behind the public setAttrs method, to set 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.

`_setAttrVal`

(

attrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]

)

Booolean private

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

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

attrName String

The attribute name.
subAttrName String

The sub-attribute name, if setting a sub-attribute property ("x.y.z").
prevVal Any

The currently stored value of the attribute.
newVal Any

The value which is going to be stored.
[opts] Object optional

Optional data providing the circumstances for the change.
[attrCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.

Returns:

Booolean:

true if the new attribute value was stored, false if not.

`_setHTML`

(

value

)

HTML protected

Inherited from Editor.Base but overwritten in src/sm-editor/js/extensions/editor-format.js:154

Setter for the html attribute.

Parameters:

value HTML

HTML.

Returns:

HTML:

HTML.

`_setStateVal`

(

name
value

)

private

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

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
value Any

The value of the attribute

`_setText`

(

value

)

String protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:532

Setter for the text attribute.

Parameters:

value String

Text.

Returns:

String:

Text.

`_splitRange`

(

range
selector

)

Node protected

Inherited from Editor.Block: src/sm-editor/js/extensions/editor-block.js:270

Splits elements after the given range until a node matching the given selector is reached.

Parameters:

range Range
selector String

Returns:

Node:

The node created after splitting

`_unlink`

() protected

Inherited from Editor.Link: src/sm-editor/js/extensions/editor-link.js:164

Removes link by replacing the anchor element with the child nodes of the anchor

The anchor element will be removed from the DOM and destroyed.

`_updateSelection`

(

[options]

)

protected

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:548

Refreshes the editor's internal knowledge of the current document selection state and fires a selectionChange event if the selection has changed since it was last refreshed.

Parameters:

[options] Object optional

Options.
- [force=false] Boolean optional
  
  If true, the internal selection state will be updated regardless of if the selection changed.
- [silent=false] Boolean optional
  
  If true, the selectionChange event will be suppressed.

`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`

(

)

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:

o EventTarget

the target to add

`after`

(

type
fn
[context]
[arg*]

)

EventHandle

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

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

`attachEvents`

(

[events]

)

chainable

Inherited from View: app/js/view.js:181

Attaches delegated event handlers to this view's container element. This method is called internally to subscribe to events configured in the events attribute when the view is initialized.

You may override this method to customize the event attaching logic.

Parameters:

[events] Object optional

Hash of events to attach. See the docs for the events attribute for details on the format. If not specified, this view's events property will be used.

`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:871

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

`blur`

() chainable

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:144

Removes focus from this editor.

`bubble`

(

evt

)

Boolean

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

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

Parameters:

evt CustomEvent

the custom event to propagate

Returns:

Boolean:

the aggregated return value from Event.Custom.fire

`command`

(

name
[args]

)

Any

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:158

Executes a given editor command.

By default, the only supported commands are:

insertHTML
insertText

See individual editor extensions for additionally supported commands

Parameters:

name String | Function

Command name or function to execute.
[args] Any optional multiple

0..n arguments to pass to the command

Returns:

Any:

Value of the specified command.

`create`

(

[container]

)

Node

Inherited from View: app/js/view.js:233

Creates and returns a container node for this view.

By default, the container is created from the HTML template specified in the containerTemplate property, and is not added to the DOM automatically.

You may override this method to customize how the container node is created (such as by rendering it from a custom template format). Your method must return a Y.Node instance.

Parameters:

[container] HTMLElement | Node | String optional

Selector string, Y.Node instance, or DOM element to use at the container node.

Returns:

Node:

Node instance of the created container node.

`destroy`

(

[options]

)

chainable

Inherited from BaseObservable but overwritten in app/js/view.js:146

Destroys this View, detaching any DOM events and optionally also destroying its container node.

By default, the container node will not be destroyed. Pass an options object with a truthy remove property to destroy the container as well.

Parameters:

[options] Object optional

Options.
- [remove=false] Boolean optional
  
  If true, this View's container will be removed from the DOM and destroyed as well.

`detach`

(

type
fn
context

)

EventTarget

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

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:469

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

`detachEvents`

() chainable

Inherited from View: app/js/view.js:253

Detaches DOM events that have previously been attached to the container by attachEvents().

`fire`

(

type
arguments

)

Boolean

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

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`

() chainable

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:205

Focuses this editor.

`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 Array | 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.

`getEvent`

(

type
prefixed

)

CustomEvent

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

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

`getTargets`

()

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

Returns an array of bubble targets for this object.

Returns:

EventTarget[]

`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

`isLink`

() Boolean

Inherited from Editor.Link: src/sm-editor/js/extensions/editor-link.js:80

Returns whether or not the current range is entirely in an anchor element

Returns:

Boolean:

true if the range is contained in an anchor element, false otherwise

`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.

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.

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, or pass an array of event names as the first argument to subscribe to all listed events with the same callback.

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=this._yuievt.config.prefix]

)

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=this._yuievt.config.prefix] String optional

the 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:493

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': whether or not the YUI instance and YUI global are notified when the event is fired (false)
- 'bubbles': whether or not this event bubbles (true) Events can only bubble if emitFacade is true.
- 'context': the default execution context for the listeners (this)
- 'defaultFn': the default function to execute when this event fires if preventDefault was not called
- 'emitFacade': whether or not this event emits a facade (false)
- 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
- 'fireOnce': if an event is configured to fire once, new subscribers after the fire will be notified immediately.
- 'async': fireOnce event listeners will fire synchronously if the event has already fired unless async is true.
- 'preventable': whether or not preventDefault() has an effect (true)
- 'preventedFn': a function that is executed when preventDefault is called
- 'queuable': whether or not this event can be queued during bubbling (false)
- 'silent': if silent is true, debug messages are not provided for this event.
- 'stoppedFn': a function that is executed when stopPropagation is called
- 'monitored': specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
- 'type': the event type (valid option if not provided as the first parameter to publish)

Returns:

CustomEvent:

the custom event

`query`

(

name

)

Boolean | String

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:219

Gets the value of a specified editor command.

See https://developer.mozilla.org/en-US/docs/Rich-Text_Editing_in_Mozilla for a list of possible commands.

Parameters:

name String

Command name.

Returns:

Boolean | String:

Value of the specified command.

`remove`

() chainable

Inherited from View: app/js/view.js:272

Removes this view's container element from the DOM (if it's in the DOM), but doesn't destroy it or any event listeners attached to it.

`removeAttr`

(

name

)

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

Removes an attribute from the host object

Parameters:

name String

The name of the attribute to be removed.

`removeTarget`

(

)

chainable

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

Removes a bubble target

Parameters:

o EventTarget

the target to remove

`render`

() chainable

Inherited from View but overwritten in src/sm-editor/js/editor-base.js:253

Renders this editor into its container and appends the container to the document if necessary.

`reset`

(

name

)

Object chainable

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

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.

`styles`

(

[styles]

)

Object

Inherited from Editor.Style: src/sm-editor/js/extensions/editor-style.js:192

Gets and/or sets the values of multiple editor style commands.

When called without an argument, the current values of all supported style commands will be returned. When called with a styles object, the specified style commands will be set to their given values, and the resulting new values will be returned.

Parameters:

[styles] Object optional

Hash of style names and values to set.

Returns:

Object:

Hash of style names and values that were set, or all styles if no styles parameter was specified.

`subscribe`

() deprecated

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

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:459

Deprecated: use detach

detach a listener

`unsubscribeAll`

(

type

)

deprecated

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

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

Properties

`_allowAdHocAttrs`

Boolean protected

Inherited from BaseCore but overwritten in app/js/view.js:111

Available since 3.5.0

This tells Y.Base that it should create ad-hoc attributes for config properties passed to View's constructor. This makes it possible to instantiate a view and set a bunch of attributes without having to subclass Y.View and declare all those attributes first.

Default: true

`_commandQueue`

Object

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:44

Hash of commands queued for execution on the next keypress.

Workaround for webkit bug where it wont place a caret in an empty node or between nodes.

`blockCommands`

Object

Inherited from Editor.Block: src/sm-editor/js/extensions/editor-block.js:31

Hash of block commands supported by this editor.

Names should correspond with valid execCommand() command names. Values are properties in the following format:

Sub-properties:

commandFn Function | String
[queryFn] Function | String optional

`blockTags`

String

Inherited from Editor.Block: src/sm-editor/js/extensions/editor-block.js:81

HTML tags supported by this editor. Unsupported tags will be treated as text

`classNames`

Object

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:67

CSS class names used by this editor.

Sub-properties:

cursor String

Class name used for a placeholder node that represents the cursor position.
editor String

Class name used for the editor's container.
input String

Class name used for the WYSIWYG YUI Editor frame that will receive user input.

`commands`

Object

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:96

Hash of commands supported by this editor.

Names should correspond with valid execCommand() command names. Values are properties in the following format:

Sub-properties:

commandFn Function | String
[queryFn] Function | String optional

`containerTemplate`

String

Inherited from View: app/js/view.js:40

Available since 3.5.0

Template for this view's container.

Default: "<div/>"

`deleteCommands`

Object

Inherited from Editor.Delete: src/sm-editor/js/extensions/editor-delete.js:30

Hash of delete commands supported by this editor.

Names should correspond with valid execCommand() command names. Values are properties in the following format:

Sub-properties:

commandFn Function | String
[queryFn] Function | String optional

`deleteKeyCommands`

Object

Inherited from Editor.Delete: src/sm-editor/js/extensions/editor-delete.js:51

Key commands related to delete functionality.

`events`

Object

Inherited from View: app/js/view.js:50

Hash of CSS selectors mapped to events to delegate to elements matching those selectors.

CSS selectors are relative to the container element. Events are attached to the container, and delegation is used so that subscribers are only notified of events that occur on elements inside the container that match the specified selectors. This allows the container's contents to be re- rendered as needed without losing event subscriptions.

Event handlers can be specified either as functions or as strings that map to function names on this view instance or its prototype.

The this object in event handlers will refer to this view instance. If you'd prefer this to be something else, use Y.bind() to bind a custom this object.

Default: {}

Example:

var view = new Y.View({
    events: {
        // Call this.toggle() whenever the element with the id
        // "toggle-button" is clicked.
        '#toggle-button': {click: 'toggle'},

        // Call this.hoverOn() when the mouse moves over any element
        // with the "hoverable" class, and this.hoverOff() when the
        // mouse moves out of any element with the "hoverable" class.
        '.hoverable': {
            mouseover: 'hoverOn',
            mouseout : 'hoverOff'
        }
    }
});

`ignoreKeyCodes`

Object

Inherited from Editor.Keys: src/sm-editor/js/extensions/editor-keys.js:22

Hash of keyCode values that should be ignored when processing keyboard events.

This is used to avoid double-handling of modifier keys, since other event properties are used to detect whether modifier keys are pressed.

`keyCodeMap`

Object

Inherited from Editor.Keys: src/sm-editor/js/extensions/editor-keys.js:40

Mapping of keyCode values to friendly names for special keys.

`keyCommands`

Object

Inherited from Editor.Keys: src/sm-editor/js/extensions/editor-keys.js:71

Mapping of shortcut keys to function handlers.

`linkCommands`

Object

Inherited from Editor.Link: src/sm-editor/js/extensions/editor-link.js:27

Hash of link commands supported by this editor.

Names should correspond with valid execCommand() command names. Values are properties in the following format:

Sub-properties:

commandFn Function | String
[queryFn] Function | String optional

`linkTemplate`

Object

Inherited from Editor.Link: src/sm-editor/js/extensions/editor-link.js:57

HTML Template for building an anchor node

`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.

`queueKeyCommands`

Object

Inherited from Editor.Queue: src/sm-editor/js/extensions/editor-queue.js:23

Key commands related to queue functionality.

`selection`

Selection

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:83

Y.Selection instance representing the current document selection.

The selection object's state always reflects the current selection, so it will update when the selection changes. If you need to retain the state of a past selection, hold onto a Range instance representing that selection.

Also, beware: this selection object reflects the current selection in the entire browser document, not just within this editor.

`styleCommands`

Object

Inherited from Editor.Style: src/sm-editor/js/extensions/editor-style.js:39

Hash of style commands supported by this editor.

Names should correspond with valid execCommand() command names. Values are properties in the following format:

Sub-properties:

commandFn Function | String
[queryFn] Function | String optional
style Object

`styleCommands.bold`

Object

Inherited from Editor.Style: src/sm-editor/js/extensions/editor-style.js:55

`styleKeyCommands`

Object

Inherited from Editor.Style but overwritten in src/sm-editor/js/extensions/editor-block.js:63

Key commands related to block functionality.

`supportedTags`

String

Inherited from Editor.Style but overwritten in src/sm-editor/js/extensions/editor-link.js:49

HTML tags supported by this editor. Unsupported tags will be treated as text

`template`

Mixed

Inherited from View: app/js/view.js:91

Template for this view's contents.

This is a convenience property that has no default behavior of its own. It's only provided as a convention to allow you to store whatever you consider to be a template, whether that's an HTML string, a Y.Node instance, a Mustache template, or anything else your little heart desires.

How this template gets used is entirely up to you and your custom render() method.

Default: ''

Attributes

Function readonly

Inherited from Editor.Format: src/sm-editor/js/extensions/editor-format.js:169

Function for formatting editor html

One day allow custom formatting. Today is not that day.

Fires event `Change`

Fires when the value for the configuration attribute `` 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`

HTMLElement | Node | String

Inherited from View: app/js/view.js:376

Container node into which this view's content will be rendered.

The container node serves as the host for all DOM events attached by the view. Delegation is used to handle events on children of the container, allowing the container's contents to be re-rendered at any time without losing event subscriptions.

The default container is a <div> Node, but you can override this in a subclass, or by passing in a custom container config value at instantiation time. If you override the default container in a subclass using ATTRS, you must use the valueFn property. The view's constructor will ignore any assignments using value.

When container is overridden by a subclass or passed as a config option at instantiation time, you can provide it as a selector string, a DOM element, a Y.Node instance, or (if you are subclassing and modifying the attribute), a valueFn function that returns a Y.Node instance. The value will be converted into a Y.Node instance if it isn't one already.

The container is not added to the page automatically. This allows you to have full control over how and when your view is actually rendered to the page.

Default: Y.Node.create(this.containerTemplate)

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.

`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.

`html`

HTML

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:733

HTML content of this editor.

Default: ''

Fires event `htmlChange`

Fires when the value for the configuration attribute html 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.

`outputName`

String

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:745

Form field name to use for the hidden <textarea> that contains the raw output of the editor in the configured output format. This name will only be used if the output node doesn't already have a name when the editor is rendered.

You may need to customize this if you plan to use the editor in a form that will be submitted to a server.

Default: 'editor'

Fires event `outputNameChange`

Fires when the value for the configuration attribute outputName 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.

`text`

String

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:763

Text content of this editor, with no HTML.

Default: ''

Fires event `textChange`

Fires when the value for the configuration attribute text 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

`blur`

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:31

Fired after this editor loses focus.

`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:

e EventFacade

Event object

`focus`

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:38

Fired after this editor receives focus.

`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.

`render`

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:45

Fired after this editor is rendered.

`selectionChange`

Inherited from Editor.Base: src/sm-editor/js/editor-base.js:52

Fired when this editor's selection changes.

Event Payload:

prevRange Range

Range that was previously selected, or null if there was no previous selection.
range Range

Range that's now selected, or null if the current selection is empty or outside the editor.
selection Selection

Reference to this editor's Selection instance.

APIs

Editor Class

Constructor

Editor

Item Index

Methods

Properties

Attributes

Events

Methods

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_addOutOfOrder

Parameters:

_afterContainerChange

_aggregateAttrs

Parameters:

Returns:

_attachBlockEvents

_attachEvents

_attachKeyEvents

_attachQueueEvents

_attrCfgHash

_baseDestroy

_baseInit

_blockOnSelectionChange

Parameters:

_clearCommandQueue

_cloneDefaultValue

Parameters:

_createLink

Parameters:

_defAttrChangeFn

Parameters:

_defDestroyFn

Parameters:

_defInitFn

Parameters:

_delete

Parameters:

_destroyContainer

_destroyHierarchy

_detachBlockEvents

_detachEvents

_detachKeyEvents

_detachQueueEvents

_execCommand

Parameters:

_execStyleCommand

Parameters:

_filterAdHocAttrs

Parameters:

Returns:

_fireAttrChange

Parameters:

_flushCommandQueue

_formatBlock

Parameters:

_formatHTML

Parameters:

Returns:

_forwardDelete

_getAnchorNode

Returns:

_getAttr

Parameters:

Returns:

_getAttrCfg

Parameters:

Returns:

_getAttrCfgs

Returns:

_getAttrInitVal

Parameters:

Returns:

_getAttrs

Parameters:

Returns:

`Editor`

`_addAttrs`

`_addLazyAttr`

`_addOutOfOrder`

`_afterContainerChange`

`_aggregateAttrs`

`_attachBlockEvents`

`_attachEvents`

`_attachKeyEvents`

`_attachQueueEvents`

`_attrCfgHash`

`_baseDestroy`

`_baseInit`

`_blockOnSelectionChange`

`_clearCommandQueue`

`_cloneDefaultValue`

`_createLink`

`_defAttrChangeFn`

`_defDestroyFn`

`_defInitFn`

`_delete`

`_destroyContainer`

`_destroyHierarchy`

`_detachBlockEvents`

`_detachEvents`

`_detachKeyEvents`

`_detachQueueEvents`

`_execCommand`

`_execStyleCommand`

`_filterAdHocAttrs`

`_fireAttrChange`

`_flushCommandQueue`

`_formatBlock`

`_formatHTML`

`_forwardDelete`

`_getAnchorNode`

`_getAttr`

`_getAttrCfg`

`_getAttrCfgs`

`_getAttrInitVal`

`_getAttrs`

`_getClasses`

`_getContainer`

`_getFullType`

`_getHTML`

`_getInstanceAttrCfgs`

`_getNodes`

`_getStateVal`

`_getStyleNodes`

`_getText`

`_getType`

`_hasPotentialSubscribers`

`_initAttrHost`

`_initAttribute`

`_initAttrs`

`_initBase`

`_initHierarchy`

`_initHierarchyData`

`_insertHTML`

`_insertReturn`

`_insertTab`

`_insertText`

`_isBlockNode`

`_isLazyAttr`

`_isStyleNode`

`_monitor`

`_noCommand`

`_normAttrVals`

`_onBlur`

`_onCopy`

`_onCut`

`_onDblClick`