Report an issue
Class

MediaFormView (media-embed/ui)

@ckeditor/ckeditor5-media-embed/src/ui/mediaformview

class

The media form view controller class.

See MediaFormView.

Filtering

Properties

  • cancelButtonView : ButtonView

    The Cancel button view.

  • element : HTMLElement

    inherited

    An HTML element of the view. null until rendered from the template.

    class SampleView extends View {
        constructor() {
            super();
    
            // A template instance the #element will be created from.
            this.setTemplate( {
                tag: 'p'
    
                // ...
            } );
        }
    }
    
    const view = new SampleView();
    
    // Renders the #template.
    view.render();
    
    // Append the HTML element of the view to <body>.
    document.body.appendChild( view.element );

    Note: The element of the view can also be assigned directly:

    view.element = document.querySelector( '#my-container' );
  • focusTracker : FocusTracker

    readonly

    Tracks information about DOM focus in the form.

  • isRendered : Boolean

    readonly inherited

    Set true when the view has already been rendered.

  • keystrokes : KeystrokeHandler

    readonly

    An instance of the KeystrokeHandler.

  • locale : Locale

    readonly inherited

    A set of tools to localize the user interface.

    Also see locale.

  • saveButtonView : ButtonView

    The Save button view.

  • template : Template

    inherited

    Template of this view. It provides the element representing the view in DOM, which is rendered.

  • url

    Sets the native DOM value of the urlInputView element.

    Note: Do not confuse it with the value which works one way only and may not represent the actual state of the component in the DOM.

  • urlInputView : LabeledInputView

    The URL input view.

  • _focusCycler : FocusCycler

    protected readonly

    Helps cycling over _focusables in the form.

  • _focusables : ViewCollection

    protected readonly

    A collection of views that can be focused in the form.

  • _unboundChildren : ViewCollection

    protected inherited

    A collection of view instances, which have been added directly into the children.

  • _validators : Array.<Function>

    protected readonly

    An array of form validators used by isValid.

  • _viewCollections : Set.<ViewCollection>

    protected inherited

    Collections registered with createCollection.

  • _bindTemplate : Object

    private inherited

    Cached bind chain object created by the template. See bindTemplate.

Methods

  • constructor( validators, [ locale ] )

    Parameters

    validators : Array.<Function>

    Form validators used by isValid.

    [ locale ] : Locale

    The localization services instance.

    Overrides: View#constructor
  • bind( bindProperties ) → Object

    inherited

    Binds obvervable properties to other objects implementing the Observable interface.

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

    Let's 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 );

    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 another observable(s).

    Returns

    Object

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

  • bindTemplate()

    inherited

    Shorthand for bind, a binding interface pre–configured for the view instance.

    It provides to() and if() methods that initialize bindings with observable attributes and attach DOM listeners.

    class SampleView extends View {
        constructor( locale ) {
            super( locale );
    
            const bind = this.bindTemplate;
    
            // These observable attributes will control
            // the state of the view in DOM.
            this.set( {
                elementClass: 'foo',
                 isEnabled: true
             } );
    
            this.setTemplate( {
                tag: 'p',
    
                attributes: {
                    // The class HTML attribute will follow elementClass
                    // and isEnabled view attributes.
                    class: [
                        bind.to( 'elementClass' )
                        bind.if( 'isEnabled', 'present-when-enabled' )
                    ]
                },
    
                on: {
                    // The view will fire the "clicked" event upon clicking <p> in DOM.
                    click: bind.to( 'clicked' )
                }
            } );
        }
    }
  • createCollection() → ViewCollection

    inherited

    Creates a new collection of views, which can be used as children of this view.

    class SampleView extends View {
        constructor( locale ) {
            super( locale );
    
            this.items = this.createCollection();
    
            this.setTemplate( {
                tag: 'p',
    
                // `items` collection will render here.
                children: this.items
            } );
        }
    }
    
    const view = new SampleView( locale );
    const child = new ChildView( locale );
    
    view.render();
    
    // It will append <p></p> to the <body>.
    document.body.appendChild( view.element );
    
    // From now on the child is nested under its parent, which is also reflected in DOM.
    // <p><child#element></p>
    view.items.add( child );

    Returns

    ViewCollection

    A new collection of view instances.

  • decorate( methodName )

    inherited

    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.

  • delegate( events ) → EmitterMixinDelegateChain

    inherited

    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
  • deregisterChild( children )

    inherited

    The opposite of registerChild. Removes a child view from this view instance. Once removed, the child is no longer managed by its parent, e.g. it can safely become a child of another parent view.

    Parameters

    children : View | Iterable.<View>

    Child views to be removed.

  • destroy()

    inherited

    Recursively destroys the view instance and child views added by registerChild and residing in collections created by the createCollection.

    Destruction disables all event listeners:

    • created on the view, e.g. view.on( 'event', () => {} ),
    • defined in the template for DOM events.
  • extendTemplate( definition )

    inherited

    Extends the template of the view with with given definition.

    A shorthand for:

    Template.extend( view.template, definition );

    Note: Is requires the template to be already set. See setTemplate.

    Parameters

    definition : TemplateDefinition

    Definition which extends the template.

  • fire( eventOrInfo, [ args ] ) → *

    inherited

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

  • focus()

    Focuses the fist _focusables in the form.

  • isValid() → Boolean

    Validates the form and returns false when some fields are invalid.

    Returns

    Boolean
  • listenTo( emitter, event, callback, [ options ] = { [options.priority] } )

    inherited

    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 {}

  • off( event, callback )

    inherited

    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.

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

    inherited

    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 {}

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

    inherited

    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 {}

  • registerChild( children )

    inherited

    Registers a new child view under the view instance. Once registered, a child view is managed by its parent, including rendering and destruction.

    To revert this, use deregisterChild.

    class SampleView extends View {
        constructor( locale ) {
            super( locale );
    
            this.childA = new SomeChildView( locale );
            this.childB = new SomeChildView( locale );
    
            this.setTemplate( { tag: 'p' } );
    
            // Register the children.
            this.registerChild( [ this.childA, this.childB ] );
        }
    
        render() {
            super.render();
    
            this.element.appendChild( this.childA.element );
            this.element.appendChild( this.childB.element );
        }
    }
    
    const view = new SampleView( locale );
    
    view.render();
    
    // Will append <p><childA#element><b></b><childB#element></p>.
    document.body.appendChild( view.element );

    Note: There's no need to add child views if they're already referenced in the template:

    class SampleView extends View {
        constructor( locale ) {
            super( locale );
    
            this.childA = new SomeChildView( locale );
            this.childB = new SomeChildView( locale );
    
            this.setTemplate( {
                tag: 'p',
    
                // These children will be added automatically. There's no
                // need to call registerChild for any of them.
                children: [ this.childA, this.childB ]
            } );
        }
    
        // ...
    }

    Parameters

    children : View | Iterable.<View>

    Children views to be registered.

  • render()

    inherited

    Recursively renders the view.

    Once the view is rendered:

    Note: The children of the view:

    In general, render() method is the right place to keep the code which refers to the element and should be executed at the very beginning of the view's life cycle.

    It is possible to extend the template before the view is rendered. To allow an early customization of the view (e.g. by its parent), such references should be done in render().

    class SampleView extends View {
        constructor() {
            this.setTemplate( {
                // ...
            } );
        },
    
        render() {
            // View#element becomes available.
            super.render();
    
            // The "scroll" listener depends on #element.
            this.listenTo( window, 'scroll', () => {
                // A reference to #element would render the #template and make it non-extendable.
                if ( window.scrollY > 0 ) {
                    this.element.scrollLeft = 100;
                } else {
                    this.element.scrollLeft = 0;
                }
            } );
        }
    }
    
    const view = new SampleView();
    
    // Let's customize the view before it gets rendered.
    view.extendTemplate( {
        attributes: {
            class: [
                'additional-class'
            ]
        }
    } );
    
    // Late rendering allows customization of the view.
    view.render();
    Overrides: View#render
  • resetFormStatus()

    Cleans up the supplementary error and information text of the urlInputView bringing them back to the state when the form has been displayed for the first time.

    See isValid.

  • set( name, [ value ] )

    inherited

    Creates and sets the value of an observable property of this object. Such an property becomes a part of the state and is be 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 have 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).

  • setTemplate( definition )

    inherited

    Sets the template of the view with with given definition.

    A shorthand for:

    view.setTemplate( definition );

    Parameters

    definition : TemplateDefinition

    Definition of view's template.

  • stopDelegating( [ event ], [ emitter ] )

    inherited

    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.

  • stopListening( [ emitter ], [ event ], [ callback ] )

    inherited

    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.

  • t()

    inherited

    Shorthand for t.

    Note: If locale instance hasn't been passed to the view this method may not be available.

  • unbind( [ unbindProperties ] )

    inherited

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

  • _createButton( label, icon, className, [ eventName ] ) → ButtonView

    private

    Creates a button view.

    Parameters

    label : String

    The button label.

    icon : String

    The button icon.

    className : String

    The additional button CSS class name.

    [ eventName ] : String

    An event name that the ButtonView#execute event will be delegated to.

    Returns

    ButtonView

    The button view instance.

  • _createUrlInput() → LabeledInputView

    private

    Creates a labeled input view.

    Returns

    LabeledInputView

    Labeled input view instance.

Events

  • cancel( eventInfo )

    Fired when the form view is canceled, e.g. click on cancelButtonView.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

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

    inherited

    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.

  • render( eventInfo )

    inherited

    Event fired by the render method. Actual rendering is executed as a listener to this event with the default priority.

    See decorate for more information and samples.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

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

    inherited

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

  • submit( eventInfo )

    Fired when the form view is submitted (when one of the children triggered the submit event), e.g. click on saveButtonView.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.