FormHeaderView (ui/formheader)

@ckeditor/ckeditor5-ui/src/formheader/formheaderview

class

The class component representing a form header view. It should be used in more advanced forms to describe the main purpose of the form.

By default the component contains a bolded label view that has to be set. The label is usually a short (at most 3-word) string. The component can also be extended by any other elements, like: icons, dropdowns, etc.

It is used i.a. by TableCellPropertiesView and SpecialCharactersNavigationView.

The latter is an example, where the component has been extended by DropdownView view.

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

children : ViewCollection

readonly

A collection of header items.

See source
class : String

observable

An additional CSS class added to the element.

See source

`element : HTMLElement`

inherited

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

See source

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

isRendered : Boolean

readonly inherited

Set true when the view has already been rendered.

See source
label : String

observable

The label of the header.

See source
locale : Locale

readonly inherited

A set of tools to localize the user interface.

See source

Also see locale.
template : Template

inherited

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

See source
_unboundChildren : ViewCollection

protected inherited

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

See source
_viewCollections : Set.<ViewCollection>

protected inherited

Collections registered with createCollection.

See source
_bindTemplate : Object

private inherited

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

See source

Methods

constructor( locale, options = { options.label, [options.class] } )

Creates an instance of the form header class.

See source

Parameters

locale : Locale

The locale instance.

options : Object

Properties

options.label : String

A label.

[ options.class ] : String

An additional class.
bind( bindProperties ) → Object

mixed
Binds observable properties to other objects implementing the Observable interface.

See source
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.

`bindTemplate()`

inherited

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

See source

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( [ views ] ) → ViewCollection`

inherited

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

See source

class SampleView extends View {
	constructor( locale ) {
		super( locale );

		const child = new ChildView( locale );
		this.items = this.createCollection( [ child ] );

		this.setTemplate( {
			tag: 'p',

			// `items` collection will render here.
			children: this.items
		} );
	}
}

const view = new SampleView( locale );
view.render();

// It will append <p><child#element></p> to the <body>.
document.body.appendChild( view.element );

Parameters

[ views ] : Iterable.<View>: Initial views of the collection.

Returns

ViewCollection: A new collection of view instances.

decorate( methodName )

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

See source
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

mixed
Delegates selected events to another Emitter. For instance:

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

See source
Parameters

children : View | Iterable.<View>

Child views to be removed.

Related:
- View#registerChild
destroy()

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

See source
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.

See source
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 ] ) → *

mixed

Fires an event, executing all callbacks registered for it.

See source

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).
listenTo( emitter, event, callback, [ options ] = { [options.priority] } )

mixed
Registers a callback function to be executed when an event is fired in a specific (emitter) object.

See source
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 )

mixed

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

See source

Parameters

event : String

The name of the event.

callback : function

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

mixed

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

See source

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] } )

mixed

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.

See source

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.

See source

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.

See source
Once the view is rendered:
- the element becomes an HTML element out of template,
- the isRendered flag is set true.
Note: The children of the view:
- defined directly in the template
- residing in collections created by the createCollection method,
- and added by registerChild are also rendered in the process.
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();
```
set( name, [ value ] )

mixed

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

See source

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).
setTemplate( definition )

inherited
Sets the template of the view with with given definition.

See source
A shorthand for:
```
view.setTemplate( definition );
```
Parameters

definition : TemplateDefinition

Definition of view's template.
stopDelegating( [ event ], [ emitter ] )

mixed
Stops delegating events. It can be used at different levels:

See source
- 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 ] )

mixed
Stops listening for events. It can be used at different levels:

See source
- 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.

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

Related:
- Locale#t
unbind( [ unbindProperties ] )

mixed
Removes the binding created with bind.

See source
```
// 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.
_addEventListener( event, callback, [ options ] = { [options.priority] } )

protected mixed

Adds callback to emitter for given event.

See source

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 {}
_removeEventListener( event, callback )

protected mixed

Removes callback from emitter for given event.

See source

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.

Events

change:class( eventInfo, name, value, oldValue )

Fired when the class property changed value.

See source

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (class).

value : String

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

oldValue : String

Old value of the class property with given key or null, if property was not set before.
change:label( eventInfo, name, value, oldValue )

Fired when the label property changed value.

See source

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (label).

value : String

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

oldValue : String

Old value of the label property with given key or null, if property was not set before.
change:{property}( eventInfo, name, value, oldValue )

mixed
Fired when a property changed value.

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

See decorate for more information and samples.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.
set:{property}( eventInfo, name, value, oldValue )

mixed
Fired when a property value is going to be set but is not set yet (before the change event is fired).

See source
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 an outdated information? Is something missing? Please report it via our issue tracker.

FormHeaderView (ui/formheader)

Filtering

Properties

children : ViewCollectionmodule:ui/formheader/formheaderview~FormHeaderView#children

class : Stringmodule:ui/formheader/formheaderview~FormHeaderView#class

element : HTMLElementmodule:ui/formheader/formheaderview~FormHeaderView#element

isRendered : Booleanmodule:ui/formheader/formheaderview~FormHeaderView#isRendered

label : Stringmodule:ui/formheader/formheaderview~FormHeaderView#label

locale : Localemodule:ui/formheader/formheaderview~FormHeaderView#locale

template : Templatemodule:ui/formheader/formheaderview~FormHeaderView#template

_unboundChildren : ViewCollectionmodule:ui/formheader/formheaderview~FormHeaderView#_unboundChildren

_viewCollections : Set.<ViewCollection>module:ui/formheader/formheaderview~FormHeaderView#_viewCollections

_bindTemplate : Objectmodule:ui/formheader/formheaderview~FormHeaderView#_bindTemplate

Methods

constructor( locale, options = { options.label, [options.class] } )module:ui/formheader/formheaderview~FormHeaderView#constructor

Parameters

bind( bindProperties ) → Objectmodule:ui/formheader/formheaderview~FormHeaderView#bind

Parameters

Returns

bindTemplate()module:ui/formheader/formheaderview~FormHeaderView#bindTemplate

createCollection( [ views ] ) → ViewCollectionmodule:ui/formheader/formheaderview~FormHeaderView#createCollection

Parameters

Returns

decorate( methodName )module:ui/formheader/formheaderview~FormHeaderView#decorate

Parameters

delegate( events ) → EmitterMixinDelegateChainmodule:ui/formheader/formheaderview~FormHeaderView#delegate

Parameters

Returns

deregisterChild( children )module:ui/formheader/formheaderview~FormHeaderView#deregisterChild

Parameters

Related:

destroy()module:ui/formheader/formheaderview~FormHeaderView#destroy

extendTemplate( definition )module:ui/formheader/formheaderview~FormHeaderView#extendTemplate

Parameters

fire( eventOrInfo, [ args ] ) → *module:ui/formheader/formheaderview~FormHeaderView#fire

Parameters

Returns

listenTo( emitter, event, callback, [ options ] = { [options.priority] } )module:ui/formheader/formheaderview~FormHeaderView#listenTo

Parameters

off( event, callback )module:ui/formheader/formheaderview~FormHeaderView#off

Parameters

on( event, callback, [ options ] = { [options.priority] } )module:ui/formheader/formheaderview~FormHeaderView#on

Parameters

once( event, callback, [ options ] = { [options.priority] } )module:ui/formheader/formheaderview~FormHeaderView#once

Parameters

registerChild( children )module:ui/formheader/formheaderview~FormHeaderView#registerChild

Parameters

render()module:ui/formheader/formheaderview~FormHeaderView#render

set( name, [ value ] )module:ui/formheader/formheaderview~FormHeaderView#set

Parameters

setTemplate( definition )module:ui/formheader/formheaderview~FormHeaderView#setTemplate

Parameters

stopDelegating( [ event ], [ emitter ] )module:ui/formheader/formheaderview~FormHeaderView#stopDelegating

Parameters

stopListening( [ emitter ], [ event ], [ callback ] )module:ui/formheader/formheaderview~FormHeaderView#stopListening

Parameters

t()module:ui/formheader/formheaderview~FormHeaderView#t

Related:

unbind( [ unbindProperties ] )module:ui/formheader/formheaderview~FormHeaderView#unbind

Parameters

_addEventListener( event, callback, [ options ] = { [options.priority] } )module:ui/formheader/formheaderview~FormHeaderView#_addEventListener

Parameters

_removeEventListener( event, callback )module:ui/formheader/formheaderview~FormHeaderView#_removeEventListener

Parameters

Events

change:class( eventInfo, name, value, oldValue )module:ui/formheader/formheaderview~FormHeaderView#event:change:class

Parameters

change:label( eventInfo, name, value, oldValue )module:ui/formheader/formheaderview~FormHeaderView#event:change:label

Parameters

change:{property}( eventInfo, name, value, oldValue )module:ui/formheader/formheaderview~FormHeaderView#event:change:{property}

Parameters

render( eventInfo )module:ui/formheader/formheaderview~FormHeaderView#event:render

Parameters

set:{property}( eventInfo, name, value, oldValue )module:ui/formheader/formheaderview~FormHeaderView#event:set:{property}

Parameters

`children : ViewCollection`

`class : String`

`element : HTMLElement`

`isRendered : Boolean`

`label : String`

`locale : Locale`

`template : Template`

`_unboundChildren : ViewCollection`

`_viewCollections : Set.<ViewCollection>`

`_bindTemplate : Object`

`constructor( locale, options = { options.label, [options.class] } )`

`bind( bindProperties ) → Object`

`bindTemplate()`

`createCollection( [ views ] ) → ViewCollection`

`decorate( methodName )`

`delegate( events ) → EmitterMixinDelegateChain`

`deregisterChild( children )`

`destroy()`

`extendTemplate( definition )`

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

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

`off( event, callback )`

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

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

`registerChild( children )`

`render()`

`set( name, [ value ] )`

`setTemplate( definition )`

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

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

`t()`

`unbind( [ unbindProperties ] )`

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

`_removeEventListener( event, callback )`

`change:class( eventInfo, name, value, oldValue )`

`change:label( eventInfo, name, value, oldValue )`

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

`render( eventInfo )`

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