WidgetTypeAround (widget)

@ckeditor/ckeditor5-widget/src/widgettypearound

class

A plugin that allows users to type around widgets where normally it is impossible to place the caret due to limitations of web browsers. These "tight spots" occur, for instance, before (or after) a widget being the first (or last) child of its parent or between two block widgets.

This plugin extends the Widget plugin and injects the user interface with two buttons into each widget instance in the editor. Each of the buttons can be clicked by the user if the widget is next to the "tight spot". Once clicked, a paragraph is created with the selection anchored in it so that users can type (or insert content, paste, etc.) straight away.

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

readonly inherited
editor : Editor
See source
The editor instance.

Note that most editors implement the EditorWithUI interface in addition to the base Editor interface. However, editors with an external UI (i.e. Bootstrap-based) or a headless editor may not implement the EditorWithUI interface.

Because of above, to make plugins more universal, it is recommended to split features into:
- The "editing" part that only uses the Editor interface.
- The "UI" part that uses both the Editor interface and the EditorWithUI interface.
readonly inherited observable
isEnabled : Boolean
See source
Flag indicating whether a plugin is enabled or disabled. A disabled plugin will not transform text.

Plugin can be simply disabled like that:
```
// Disable the plugin so that no toolbars are visible.
editor.plugins.get( 'TextTransformation' ).isEnabled = false;
```
You can also use forceDisabled method.
private
_currentFakeCaretModelElement : Element | null

See source
A reference to the model widget element that has the fake caret active on either side of it. It is later used to remove CSS classes associated with the fake caret when the widget no longer needs it.
private inherited
_disableStack : Set.<String>

See source
Holds identifiers for forceDisabled mechanism.

Static properties

readonly inherited static
isContextPlugin : Boolean

See source
A flag which defines if a plugin is allowed or not allowed to be used directly by a Context.
readonly inherited static
pluginName : String | undefined
See source
An optional name of the plugin. If set, the plugin will be available in get by its name and its constructor. If not, then only by its constructor.

The name should reflect the constructor name.

To keep the plugin class definition tight, it is recommended to define this property as a static getter:
```
export default class ImageCaption {
	static get pluginName() {
		return 'ImageCaption';
	}
}
```
Note: The native Function.name property could not be used to keep the plugin name because it will be mangled during code minification.

Naming a plugin is necessary to enable removing it through the config.removePlugins option.
readonly inherited static
requires : Array.<Function> | undefined
See source
An array of plugins required by this plugin.

To keep the plugin class definition tight it is recommended to define this property as a static getter:
```
import Image from './image.js';

export default class ImageCaption {
	static get requires() {
		return [ Image ];
	}
}
```

Methods

inherited
constructor( editor )

See source
Creates a new plugin instance. This is the first step of the plugin initialization. See also init and afterInit.

A plugin is always instantiated after its dependencies and the init and afterInit methods are called in the same order.

Usually, you will want to put your plugin's initialization code in the init method. The constructor can be understood as "before init" and used in special cases, just like afterInit serves the special "after init" scenarios (e.g.the code which depends on other plugins, but which does not explicitly require them).

Parameters

editor : Editor
inherited
afterInit() → null | Promise

See source
The third (and last) stage of the plugin initialization. See also constructor and init.

Note: This method is optional. A plugin instance does not need to have it defined.

Returns

null | Promise
mixed
bind( bindProperties ) → Object
See source
Binds observable properties to other objects implementing the Observable interface.

Read more in the dedicated guide covering the topic of property bindings with some additional examples.

Consider two objects: a button and an associated command (both Observable).

A simple property binding could be as follows:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
```
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use unbind.

You can also "rename" the property in the binding by specifying the new name in the to() chain:
```
button.bind( 'isEnabled' ).to( command, 'isWorking' );
```
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
The binding can include more than one observable, combining multiple data sources in a custom callback:
```
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
```
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:
```
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
```
Parameters

bindProperties : String

Observable properties that will be bound to other observable(s).

Returns

Object

The bind chain with the to() and toMany() methods.
inherited
clearForceDisabled( id )

See source
Clears forced disable previously set through forceDisabled. See forceDisabled.

Parameters

id : String

Unique identifier, equal to the one passed in forceDisabled call.
mixed
decorate( methodName )
See source
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

Read more in the dedicated guide covering the topic of decorating methods with some additional examples.

Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

For example, to cancel the method execution the event can be stopped:
```
class Foo {
	constructor() {
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.
```
Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

It is also possible to change the returned value:
```
foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'
```
Finally, it is possible to access and modify the arguments the method is called with:
```
method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'
```
Parameters

methodName : String

Name of the method to decorate.
mixed
delegate( events ) → EmitterMixinDelegateChain
See source
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Parameters

events : String

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
inherited
destroy() → null | Promise

See source
Destroys the plugin.

Note: This method is optional. A plugin instance does not need to have it defined.

Returns

null | Promise
mixed
fire( eventOrInfo, [ args ] ) → *

See source
Fires an event, executing all callbacks registered for it.

The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

Parameters

eventOrInfo : String | EventInfo

The name of the event or EventInfo object if event is delegated.

[ args ] : *

Additional arguments to be passed to the callbacks.

Returns

*

By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).
inherited
forceDisabled( id )
See source
Disables the plugin.

Plugin may be disabled by multiple features or algorithms (at once). When disabling a plugin, unique id should be passed (e.g. feature name). The same identifier should be used when enabling back the plugin. The plugin becomes enabled only after all features enabled it back.

Disabling and enabling a plugin:
```
plugin.isEnabled; // -> true
plugin.forceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Plugin disabled by multiple features:
```
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'OtherFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> false
plugin.clearForceDisabled( 'OtherFeature' );
plugin.isEnabled; // -> true
```
Multiple disabling with the same identifier is redundant:
```
plugin.forceDisabled( 'MyFeature' );
plugin.forceDisabled( 'MyFeature' );
plugin.clearForceDisabled( 'MyFeature' );
plugin.isEnabled; // -> true
```
Note: some plugins or algorithms may have more complex logic when it comes to enabling or disabling certain plugins, so the plugin might be still disabled after clearForceDisabled was used.

Parameters

id : String

Unique identifier for disabling. Use the same id when enabling back the plugin.
inherited
init() → null | Promise

See source
The second stage (after plugin constructor) of the plugin initialization. Unlike the plugin constructor this method can be asynchronous.

A plugin's init() method is called after its dependencies are initialized, so in the same order as the constructors of these plugins.

Note: This method is optional. A plugin instance does not need to have it defined.

Returns

null | Promise
mixed
listenTo( emitter, event, callback, [ options ] = { [options.priority] } )
See source
Registers a callback function to be executed when an event is fired in a specific (emitter) object.

Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.
```
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
```
An event callback can stop the event and set the return value of the fire method.

Parameters

emitter : Emitter

The object that fires the event.

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
mixed
off( event, callback )

See source
Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.
mixed
on( event, callback, [ options ] = { [options.priority] } )

See source
Registers a callback function to be executed when an event is fired.

Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
mixed
once( event, callback, [ options ] = { [options.priority] } )

See source
Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
mixed
set( name, [ value ] )

See source
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

It accepts also a single object literal containing key/value pairs with properties to be set.

This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

Parameters

name : String | Object

The property's name or object with name=>value pairs.

[ value ] : *

The property's value (if name was passed in the first parameter).
mixed
stopDelegating( [ event ], [ emitter ] )
See source
Stops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
Parameters

[ event ] : String

The name of the event to stop delegating. If omitted, stops it all delegations.

[ emitter ] : Emitter

(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.
mixed
stopListening( [ emitter ], [ event ], [ callback ] )
See source
Stops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
Parameters

[ emitter ] : Emitter

The object to stop listening to. If omitted, stops it for all objects.

[ event ] : String

(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

[ callback ] : function

(Requires the event) The function to be removed from the call list for the given event.
mixed
unbind( [ unbindProperties ] )
See source
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Parameters

[ unbindProperties ] : String

Observable properties to be unbound. All the bindings will be released if no properties are provided.
protected mixed
_addEventListener( event, callback, [ options ] = { [options.priority] } )

See source
Adds callback to emitter for given event.

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
protected
_insertParagraph( widgetModelElement, position )

See source
Inserts a new paragraph next to a widget element with the selection anchored in it.

Note: This method is heavily user-oriented and will both focus the editing view and scroll the viewport to the selection in the inserted paragraph.

Parameters

widgetModelElement : Element

The model widget element next to which a paragraph is inserted.

position : 'before' | 'after'

The position where the paragraph is inserted. Either 'before' or 'after' the widget.
protected mixed
_removeEventListener( event, callback )

See source
Removes callback from emitter for given event.

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.
private
_enableDeleteContentIntegration()

See source
Attaches the event-deleteContent event listener to block the event when the fake caret is active.

This is required for cases that trigger model.deleteContent() before calling model.insertContent() like, for instance, plain text pasting.
private
_enableDeleteIntegration()

See source
It creates a "delete" event listener on the view document to handle cases when the Delete or Backspace is pressed and the fake caret is currently active.

The fake caret should create an illusion of a real browser caret so that when it appears before or after a widget, pressing Delete or Backspace should remove a widget or delete the content before or after a widget (depending on the content surrounding the widget).
private
_enableInsertContentIntegration()

See source
Attaches the event-insertContent event listener that, for instance, allows the user to paste content near a widget when the fake caret is first activated using the arrow keys.

The content is inserted according to the widget-type-around selection attribute (see _handleArrowKeyPress).
private
_enableInsertObjectIntegration()

See source
Attaches the event-insertObject event listener that modifies the options.findOptimalPositionparameter to position of fake caret in relation to selected element to reflect user's intent of desired insertion position.

The object is inserted according to the widget-type-around selection attribute (see _handleArrowKeyPress).
private
_enableInsertingParagraphsOnButtonClick()

See source
Registers a mousedown listener for the view document which intercepts events coming from the widget type around UI, which happens when a user clicks one of the buttons that insert a paragraph next to a widget.
private
_enableInsertingParagraphsOnEnterKeypress()
See source
Creates the Enter key listener on the view document that allows the user to insert a paragraph near the widget when either:
- The fake caret was first activated using the arrow keys,
- The entire widget is selected in the model.
In the first case, the new paragraph is inserted according to the widget-type-around selection attribute (see _handleArrowKeyPress).

In the second case, the new paragraph is inserted based on whether a soft (Shift+Enter) keystroke was pressed or not.
private
_enableInsertingParagraphsOnTypingKeystroke()

See source
Similar to the _enableInsertingParagraphsOnEnterKeypress, it allows the user to insert a paragraph next to a widget when the fake caret was activated using arrow keys but it responds to typing instead of Enter.

Listener enabled by this method will insert a new paragraph according to the widget-type-around model selection attribute as the user simply starts typing, which creates the impression that the fake caret behaves like a real one rendered by the browser (AKA your text appears where the caret was).

Note: At the moment this listener creates 2 undo steps: one for the insertParagraph command and another one for actual typing. It is not a disaster but this may need to be fixed sooner or later.
private
_enableTypeAroundFakeCaretActivationUsingKeyboardArrows()
See source
Brings support for the fake caret that appears when either:
- the selection moves to a widget from a position next to it using arrow keys,
- the arrow key is pressed when the widget is already selected.
The fake caret lets the user know that they can start typing or just press Enter to insert a paragraph at the position next to a widget as suggested by the fake caret.

The fake caret disappears when the user changes the selection or the editor gets blurred.

The whole idea is as follows:
1. A user does one of the 2 scenarios described at the beginning.
2. The "keydown" listener is executed and the decision is made whether to show or hide the fake caret.
3. If it should show up, the widget-type-around model selection attribute is set indicating on which side of the widget it should appear.
4. The selection dispatcher reacts to the selection attribute and sets CSS classes responsible for the fake caret on the view widget.
5. If the fake caret should disappear, the selection attribute is removed and the dispatcher does the CSS class clean-up in the view.
6. Additionally, change:range and FocusTracker#isFocused listeners also remove the selection attribute (the former also removes widget CSS classes).
private
_enableTypeAroundUIInjection()

See source
Creates a listener in the editing conversion pipeline that injects the widget type around UI into every single widget instance created in the editor.

The UI is delivered as a UIElement wrapper which renders DOM buttons that users can use to insert paragraphs.
private
_handleArrowKeyPress()

See source
A listener executed on each "keydown" in the view document, a part of _enableTypeAroundFakeCaretActivationUsingKeyboardArrows.

It decides whether the arrow keypress should activate the fake caret or not (also whether it should be deactivated).

The fake caret activation is done by setting the widget-type-around model selection attribute in this listener, and stopping and preventing the event that would normally be handled by the widget plugin that is responsible for the regular keyboard navigation near/across all widgets (that includes inline widgets, which are ignored by the widget type around plugin).
private
_handleArrowKeyPressOnSelectedWidget( isForward ) → Boolean

See source
Handles the keyboard navigation on "keydown" when a widget is currently selected and activates or deactivates the fake caret for that widget, depending on the current value of the widget-type-around model selection attribute and the direction of the pressed arrow key.

Parameters

isForward : Boolean

true when the pressed arrow key was responsible for the forward model selection movement as in isForwardArrowKeyCode.

Returns

Boolean

Returns true when the keypress was handled and no other keydown listener of the editor should process the event any further. Returns false otherwise.
private
_handleArrowKeyPressWhenNonCollapsedSelection( isForward ) → Boolean

See source
Handles the keyboard navigation on "keydown" when a widget is currently selected (together with some other content) and the widget is the first or last element in the selection. It activates or deactivates the fake caret for that widget.

Parameters

isForward : Boolean

true when the pressed arrow key was responsible for the forward model selection movement as in isForwardArrowKeyCode.

Returns

Boolean

Returns true when the keypress was handled and no other keydown listener of the editor should process the event any further. Returns false otherwise.
private
_handleArrowKeyPressWhenSelectionNextToAWidget( isForward ) → Boolean

See source
Handles the keyboard navigation on "keydown" when no widget is selected but the selection is directly next to one and upon the fake caret should become active for this widget upon arrow keypress (AKA entering/selecting the widget).

Note: This code mirrors the implementation from the widget plugin but also adds the selection attribute. Unfortunately, there is no safe way to let the widget plugin do the selection part first and then just set the selection attribute here in the widget type around plugin. This is why this code must duplicate some from the widget plugin.

Parameters

isForward : Boolean

true when the pressed arrow key was responsible for the forward model selection movement as in isForwardArrowKeyCode.

Returns

Boolean

Returns true when the keypress was handled and no other keydown listener of the editor should process the event any further. Returns false otherwise.
private
_insertParagraphAccordingToFakeCaretPosition() → Boolean

See source
Similar to _insertParagraph, this method inserts a paragraph except that it does not expect a position. Instead, it performs the insertion next to a selected widget according to the widget-type-around model selection attribute value (fake caret position).

Because this method requires the widget-type-around attribute to be set, the insertion can only happen when the widget's fake caret is active (e.g. activated using the keyboard).

Returns

Boolean

Returns true when the paragraph was inserted (the attribute was present) and false otherwise.
private
_listenToIfEnabled( emitter, event, callback, [ options ] = { [options.priority] } )

See source
A wrapper for the listenTo method that executes the callbacks only when the plugin is enabled.

Parameters

emitter : Emitter

The object that fires the event.

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}

Events

inherited
change:isEnabled( eventInfo, name, value, oldValue )

See source
Fired when the isEnabled property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (isEnabled).

value : Boolean

New value of the isEnabled property with given key or null, if operation should remove property.

oldValue : Boolean

Old value of the isEnabled property with given key or null, if property was not set before.
mixed
change:{property}( eventInfo, name, value, oldValue )
See source
Fired when a property changed value.
```
observable.set( 'prop', 1 );

observable.on( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```
Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

The property name.

value : *

The new property value.

oldValue : *

The previous property value.
mixed
set:{property}( eventInfo, name, value, oldValue )
See source
Fired when a property value is going to be set but is not set yet (before the change event is fired).

You can control the final value of the property by using the event's return property.
```
observable.set( 'prop', 1 );

observable.on( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
                     // -> 'Current property value is 1'
                     // -> 'Value has changed from 1 to 3'
```
Note: The event is fired even when the new value is the same as the old value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

The property name.

value : *

The new property value.

oldValue : *

The previous property value.

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

WidgetTypeAround (widget)

Filtering

Properties

readonly inherited editor : Editormodule:widget/widgettypearound~WidgetTypeAround#editor

readonly inherited observable isEnabled : Booleanmodule:widget/widgettypearound~WidgetTypeAround#isEnabled

private _currentFakeCaretModelElement : Element | nullmodule:widget/widgettypearound~WidgetTypeAround#_currentFakeCaretModelElement

private inherited _disableStack : Set.<String>module:widget/widgettypearound~WidgetTypeAround#_disableStack

Static properties

readonly inherited static isContextPlugin : Booleanmodule:widget/widgettypearound~WidgetTypeAround.isContextPlugin

readonly inherited static pluginName : String | undefinedmodule:widget/widgettypearound~WidgetTypeAround.pluginName

readonly inherited static requires : Array.<Function> | undefinedmodule:widget/widgettypearound~WidgetTypeAround.requires

Methods

inherited constructor( editor )module:widget/widgettypearound~WidgetTypeAround#constructor

Parameters

inherited afterInit() → null | Promisemodule:widget/widgettypearound~WidgetTypeAround#afterInit

Returns

mixed bind( bindProperties ) → Objectmodule:widget/widgettypearound~WidgetTypeAround#bind

Parameters

Returns

inherited clearForceDisabled( id )module:widget/widgettypearound~WidgetTypeAround#clearForceDisabled

Parameters

mixed decorate( methodName )module:widget/widgettypearound~WidgetTypeAround#decorate

Parameters

mixed delegate( events ) → EmitterMixinDelegateChainmodule:widget/widgettypearound~WidgetTypeAround#delegate

Parameters

Returns

inherited destroy() → null | Promisemodule:widget/widgettypearound~WidgetTypeAround#destroy

Returns

mixed fire( eventOrInfo, [ args ] ) → *module:widget/widgettypearound~WidgetTypeAround#fire

Parameters

Returns

inherited forceDisabled( id )module:widget/widgettypearound~WidgetTypeAround#forceDisabled

Parameters

inherited init() → null | Promisemodule:widget/widgettypearound~WidgetTypeAround#init

Returns

mixed listenTo( emitter, event, callback, [ options ] = { [options.priority] } )module:widget/widgettypearound~WidgetTypeAround#listenTo

Parameters

mixed off( event, callback )module:widget/widgettypearound~WidgetTypeAround#off

Parameters

mixed on( event, callback, [ options ] = { [options.priority] } )module:widget/widgettypearound~WidgetTypeAround#on

Parameters

mixed once( event, callback, [ options ] = { [options.priority] } )module:widget/widgettypearound~WidgetTypeAround#once

Parameters

mixed set( name, [ value ] )module:widget/widgettypearound~WidgetTypeAround#set

Parameters

mixed stopDelegating( [ event ], [ emitter ] )module:widget/widgettypearound~WidgetTypeAround#stopDelegating

Parameters

mixed stopListening( [ emitter ], [ event ], [ callback ] )module:widget/widgettypearound~WidgetTypeAround#stopListening

Parameters

mixed unbind( [ unbindProperties ] )module:widget/widgettypearound~WidgetTypeAround#unbind

Parameters

protected mixed _addEventListener( event, callback, [ options ] = { [options.priority] } )module:widget/widgettypearound~WidgetTypeAround#_addEventListener

Parameters

protected _insertParagraph( widgetModelElement, position )module:widget/widgettypearound~WidgetTypeAround#_insertParagraph

Parameters

protected mixed _removeEventListener( event, callback )module:widget/widgettypearound~WidgetTypeAround#_removeEventListener

Parameters

private _enableDeleteContentIntegration()module:widget/widgettypearound~WidgetTypeAround#_enableDeleteContentIntegration

private _enableDeleteIntegration()module:widget/widgettypearound~WidgetTypeAround#_enableDeleteIntegration

private _enableInsertContentIntegration()module:widget/widgettypearound~WidgetTypeAround#_enableInsertContentIntegration

private _enableInsertObjectIntegration()module:widget/widgettypearound~WidgetTypeAround#_enableInsertObjectIntegration

private _enableInsertingParagraphsOnButtonClick()module:widget/widgettypearound~WidgetTypeAround#_enableInsertingParagraphsOnButtonClick

private _enableInsertingParagraphsOnEnterKeypress()module:widget/widgettypearound~WidgetTypeAround#_enableInsertingParagraphsOnEnterKeypress

private _enableInsertingParagraphsOnTypingKeystroke()module:widget/widgettypearound~WidgetTypeAround#_enableInsertingParagraphsOnTypingKeystroke

private _enableTypeAroundFakeCaretActivationUsingKeyboardArrows()module:widget/widgettypearound~WidgetTypeAround#_enableTypeAroundFakeCaretActivationUsingKeyboardArrows

private _enableTypeAroundUIInjection()module:widget/widgettypearound~WidgetTypeAround#_enableTypeAroundUIInjection

private _handleArrowKeyPress()module:widget/widgettypearound~WidgetTypeAround#_handleArrowKeyPress

private _handleArrowKeyPressOnSelectedWidget( isForward ) → Booleanmodule:widget/widgettypearound~WidgetTypeAround#_handleArrowKeyPressOnSelectedWidget

Parameters

Returns

private _handleArrowKeyPressWhenNonCollapsedSelection( isForward ) → Booleanmodule:widget/widgettypearound~WidgetTypeAround#_handleArrowKeyPressWhenNonCollapsedSelection

Parameters

Returns

private _handleArrowKeyPressWhenSelectionNextToAWidget( isForward ) → Booleanmodule:widget/widgettypearound~WidgetTypeAround#_handleArrowKeyPressWhenSelectionNextToAWidget

Parameters

Returns

private _insertParagraphAccordingToFakeCaretPosition() → Booleanmodule:widget/widgettypearound~WidgetTypeAround#_insertParagraphAccordingToFakeCaretPosition

Returns

private _listenToIfEnabled( emitter, event, callback, [ options ] = { [options.priority] } )module:widget/widgettypearound~WidgetTypeAround#_listenToIfEnabled

Parameters

readonly inherited
`editor : Editor`

readonly inherited observable
`isEnabled : Boolean`

private
`_currentFakeCaretModelElement : Element | null`

private inherited
`_disableStack : Set.<String>`

readonly inherited static
`isContextPlugin : Boolean`

readonly inherited static
`pluginName : String | undefined`

readonly inherited static
`requires : Array.<Function> | undefined`

inherited
`constructor( editor )`

inherited
`afterInit() → null | Promise`

mixed
`bind( bindProperties ) → Object`

inherited
`clearForceDisabled( id )`

mixed
`decorate( methodName )`

mixed
`delegate( events ) → EmitterMixinDelegateChain`

inherited
`destroy() → null | Promise`

mixed
`fire( eventOrInfo, [ args ] ) → *`

inherited
`forceDisabled( id )`

inherited
`init() → null | Promise`

mixed
`listenTo( emitter, event, callback, [ options ] = { [options.priority] } )`

mixed
`off( event, callback )`

mixed
`on( event, callback, [ options ] = { [options.priority] } )`

mixed
`once( event, callback, [ options ] = { [options.priority] } )`

mixed
`set( name, [ value ] )`

mixed
`stopDelegating( [ event ], [ emitter ] )`

mixed
`stopListening( [ emitter ], [ event ], [ callback ] )`

mixed
`unbind( [ unbindProperties ] )`

protected mixed
`_addEventListener( event, callback, [ options ] = { [options.priority] } )`

protected
`_insertParagraph( widgetModelElement, position )`

protected mixed
`_removeEventListener( event, callback )`

private
`_enableDeleteContentIntegration()`

private
`_enableDeleteIntegration()`

private
`_enableInsertContentIntegration()`

private
`_enableInsertObjectIntegration()`

private
`_enableInsertingParagraphsOnButtonClick()`

private
`_enableInsertingParagraphsOnEnterKeypress()`

private
`_enableInsertingParagraphsOnTypingKeystroke()`

private
`_enableTypeAroundFakeCaretActivationUsingKeyboardArrows()`

private
`_enableTypeAroundUIInjection()`

private
`_handleArrowKeyPress()`

private
`_handleArrowKeyPressOnSelectedWidget( isForward ) → Boolean`

private
`_handleArrowKeyPressWhenNonCollapsedSelection( isForward ) → Boolean`

private
`_handleArrowKeyPressWhenSelectionNextToAWidget( isForward ) → Boolean`

private
`_insertParagraphAccordingToFakeCaretPosition() → Boolean`

private
`_listenToIfEnabled( emitter, event, callback, [ options ] = { [options.priority] } )`

inherited
`change:isEnabled( eventInfo, name, value, oldValue )`

mixed
`change:{property}( eventInfo, name, value, oldValue )`

mixed
`set:{property}( eventInfo, name, value, oldValue )`