CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

FindAndReplaceFormView (find-and-replace/ui)

@ckeditor/ckeditor5-find-and-replace/src/ui/findandreplaceformview

class
See source

The find and replace form view class.

See FindAndReplaceFormView.

Filtering

Properties

  • readonly

    _textToFind : string

    See source

    Returns the value of the find input.

  • readonly

    _textToReplace : string

    See source

    Returns the value of the replace input.

  • readonly inherited

    bindTemplate : BindChain<this>

    See source

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

  • inherited

    element : null | HTMLElement

    See source

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

  • readonly observable

    highlightOffset : number

    See source

    The offset of currently highlighted search result in matched results.

  • observable

    isDirty : boolean

    See source

    true when the search params (find text, options) has been changed by the user since the last time find was executed. false otherwise.

  • inherited

    isRendered : boolean

    See source

    Set true when the view has already been rendered.

  • locale : Locale

    See source

    A set of tools to localize the user interface.

    Also see locale.

  • observable

    matchCount : number

    See source

    Stores the number of matched search results.

  • inherited

    t : undefined | LocaleTranslate

    See source

    Shorthand for t.

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

    Related:

  • inherited

    template : Template | undefined

    See source

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

  • inherited

    viewUid : string | undefined

    See source

  • internal readonly observable

    _areCommandsEnabled : Record<string, boolean>

    See source

    A live object with the aggregated isEnabled states of editor commands related to find and replace. For instance, it may look as follows:

    {
	findNext: true,
	findPrevious: true,
	replace: false,
	replaceAll: false
}

  • internal readonly

    _findInputView : LabeledFieldView<InputView>

    See source

    The find in text input view that stores the searched string.

  • internal observable

    _matchCase : boolean

    See source

    The flag reflecting the state of the "Match case" switch button in the search options dropdown.

  • internal observable

    _resultsCounterText : string

    See source

    The content of the counter label displaying the index of the current highlighted match on top of the find input, for instance "3 of 50".

  • internal readonly observable

    _searchResultsFound : boolean

    See source

    This flag is set true when some matches were found and the user didn't change the search params (text to find, options) yet. This is only possible immediately after hitting the "Find" button. false when there were no matches (see matchCount) or the user changed the params (see isDirty).

    It is used to control the enabled state of the replace UI (input and buttons); replacing text is only possible if this flag is true.

  • internal observable

    _wholeWordsOnly : boolean

    See source

    The flag reflecting the state of the "Whole words only" switch button in the search options dropdown.

  • protected inherited

    _unboundChildren : ViewCollection<View<HTMLElement>>

    See source

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

  • protected inherited

    _viewCollections : Collection<ViewCollection<View<HTMLElement>>>

    See source

    Collections registered with createCollection.

  • private readonly

    _findButtonView : ButtonView

    See source

    The find button view that initializes the search process.

  • private readonly

    _findFieldsetView : View<HTMLElement>

    See source

    The fieldset aggregating the find UI.

  • private readonly

    _findNextButtonView : ButtonView

    See source

    The find next button view.

  • private readonly

    _findPrevButtonView : ButtonView

    See source

    The find previous button view.

  • private readonly

    _focusCycler : FocusCycler

    See source

    Helps cycling over _focusables in the form.

  • private readonly

    _focusTracker : FocusTracker

    See source

    Tracks information about the DOM focus in the form.

  • private readonly

    _focusables : ViewCollection<View<HTMLElement>>

    See source

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

  • private readonly

    _keystrokes : KeystrokeHandler

    See source

    An instance of the KeystrokeHandler.

  • private readonly

    _optionsDropdown : default

    See source

    The find options dropdown.

  • private readonly

    _replaceAllButtonView : ButtonView

    See source

    The replace all button view.

  • private readonly

    _replaceButtonView : ButtonView

    See source

    The replace button view.

  • private readonly

    _replaceFieldsetView : View<HTMLElement>

    See source

    The fieldset aggregating the replace UI.

  • private readonly

    _replaceInputView : LabeledFieldView<FocusableView>

    See source

    The replace input view.

Methods

  • constructor( locale )

    See source

    Creates a view of find and replace form.

    Parameters

    locale : Locale

    The localization services instance.

  • inherited

    bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, FindAndReplaceFormView[ K1 ], K2, FindAndReplaceFormView[ K2 ]>

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

    Type parameters

    K1
    K2

    Parameters

    bindProperty1 : K1

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

    bindProperty2 : K2

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

    Returns

    DualBindChain<K1, FindAndReplaceFormView[ K1 ], K2, FindAndReplaceFormView[ K2 ]>

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

  • inherited

    bind( bindProperties ) → MultiBindChain

    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 : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'element' | 'template' | 'focus' | 'reset' | 'destroy' | 'render' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'matchCount' | 'highlightOffset' | 'isDirty' | '_areCommandsEnabled' | '_resultsCounterText' | '_matchCase' | '_wholeWordsOnly' | '_searchResultsFound' | '_findInputView'>

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

    Returns

    MultiBindChain

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

  • inherited

    bind( bindProperty ) → SingleBindChain<K, FindAndReplaceFormView[ K ]>

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

    Type parameters

    K

    Parameters

    bindProperty : K

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

    Returns

    SingleBindChain<K, FindAndReplaceFormView[ K ]>

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

  • inherited

    createCollection( [ views ] ) → ViewCollection<T>

    See source

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

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

    Type parameters

    T : extends [object Object] = default

    Parameters

    [ views ] : Iterable<T>

    Initial views of the collection.

    Returns

    ViewCollection<T>

    A new collection of view instances.

  • inherited

    decorate( methodName ) → void

    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 extends ObservableMixin() {
	constructor() {
		super();
		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 : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'element' | 'template' | 'focus' | 'reset' | 'destroy' | 'render' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'matchCount' | 'highlightOffset' | 'isDirty' | '_areCommandsEnabled' | '_resultsCounterText' | '_matchCase' | '_wholeWordsOnly' | '_searchResultsFound' | '_findInputView'

    Name of the method to decorate.

    Returns

    void

  • inherited

    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 : Array<string>

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain

  • inherited

    deregisterChild( children ) → void

    See source

    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<HTMLElement> | Iterable<View<HTMLElement>>

    Child views to be removed.

    Returns

    void

    Related:

  • destroy() → void

    See source

    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.

    Returns

    void

  • inherited

    extendTemplate( definition ) → void

    See source

    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 : Partial<TemplateDefinition>

    Definition which extends the template.

    Returns

    void

  • inherited

    fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

    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.

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    eventOrInfo : GetNameOrEventInfo<TEvent>

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

    args : TEvent[ 'args' ]

    Additional arguments to be passed to the callbacks.

    Returns

    GetEventInfo<TEvent>[ 'return' ]

    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() → void

    See source

    Focuses the fist _focusables in the form.

    Returns

    void

  • inherited

    listenTo( emitter, event, callback, [ options ] ) → void

    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.

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : CallbackOptions

    Additional options.

    Returns

    void

  • inherited

    listenTo( emitter, event, callback, [ options ] ) → void

    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.

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void

  • inherited

    listenTo( emitter, event, callback, [ options ] ) → void

    See source

    Registers a callback function to be executed when an event is fired in a specific Emitter or DOM Node. It is backwards compatible with listenTo.

    Type parameters

    K : extends keyof DomEventMap

    Parameters

    emitter : Node | Window

    The object that fires the event.

    event : K

    The name of the event.

    callback : ( FindAndReplaceFormView, EventInfo<string, unknown>, DomEventMap[ K ] ) => void

    The function to be called on event.

    [ options ] : object

    Additional options.

    Returns

    void

  • inherited

    off( event, callback ) → void

    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.

    Returns

    void

  • inherited

    on( event, callback, [ options ] ) → void

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

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void

  • inherited

    once( event, callback, [ options ] ) → void

    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.

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void

  • inherited

    registerChild( children ) → void

    See source

    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<HTMLElement> | Iterable<View<HTMLElement>>

    Children views to be registered.

    Returns

    void

  • render() → void

    See source

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

    Returns

    void

  • reset() → void

    See source

    Resets the form before re-appearing.

    It clears error messages, hides the match counter and disables the replace feature until the next hit of the "Find" button.

    Note: It does not reset inputs and options, though. This way the form works better in editors with disappearing toolbar (e.g. BalloonEditor): hiding the toolbar by accident (together with the find and replace UI) does not require filling the entire form again.

    Returns

    void

  • inherited

    set( values ) → void

    See source

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

    It accepts 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.

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}

    Parameters

    values : object

    An object with name=>value pairs.

    Returns

    void

  • inherited

    set( name, value ) → void

    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.

    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.

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}

    Type parameters

    K

    Parameters

    name : K

    The property's name.

    value : FindAndReplaceFormView[ K ]

    The property's value.

    Returns

    void

  • inherited

    setTemplate( definition ) → void

    See source

    Sets the template of the view with with given definition.

    A shorthand for:

    view.setTemplate( definition );

    Parameters

    definition : TemplateDefinition

    Definition of view's template.

    Returns

    void

  • inherited

    stopDelegating( [ event ], [ emitter ] ) → void

    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.

    Returns

    void

  • inherited

    stopListening( [ emitter ], [ event ], [ callback ] ) → void

    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.

    Returns

    void

  • inherited

    stopListening( [ emitter ], [ event ], [ callback ] ) → void

    See source

    Stops listening for events. It can be used at different levels: It is backwards compatible with listenTo.

    • 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 | Node | Window

    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.

    Returns

    void

  • inherited

    unbind( unbindProperties ) → void

    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 : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'element' | 'template' | 'focus' | 'reset' | 'destroy' | 'render' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'matchCount' | 'highlightOffset' | 'isDirty' | '_areCommandsEnabled' | '_resultsCounterText' | '_matchCase' | '_wholeWordsOnly' | '_searchResultsFound' | '_findInputView'>

    Observable properties to be unbound. All the bindings will be released if no properties are provided.

    Returns

    void

  • private

    _createButton( options ) → ButtonView

    See source

    Creates a button view.

    Parameters

    options : object

    The properties of the ButtonView.

    Returns

    ButtonView

    The button view instance.

  • private

    _createFindFieldset() → View<HTMLElement>

    See source

    Configures and returns the <fieldset> aggregating all find controls.

    Returns

    View<HTMLElement>

  • private

    _createInputField( label ) → LabeledFieldView<InputView>

    See source

    Creates a labeled input view.

    Parameters

    label : string

    The input label.

    Returns

    LabeledFieldView<InputView>

    The labeled input view instance.

  • private

    _createOptionsDropdown() → default

    See source

    Creates, configures and returns and instance of a dropdown allowing users to narrow the search criteria down. The dropdown has a list with switch buttons for each option.

    Returns

    default

  • private

    _createReplaceFieldset() → View<HTMLElement>

    See source

    Configures and returns the <fieldset> aggregating all replace controls.

    Returns

    View<HTMLElement>

  • private

    _initFocusCycling() → void

    See source

    Initializes the _focusables and _focusTracker to allow navigation using Tab and Shift+Tab keystrokes in the right order.

    Returns

    void

  • private

    _initKeystrokeHandling() → void

    See source

    Initializes the keystroke handling in the form.

    Returns

    void

  • private

    _injectFindResultsCounter() → void

    See source

    Configures an injects the find results counter displaying a "N of M" label of the _findInputView.

    Returns

    void

  • private

    _onFindButtonExecute() → void

    See source

    The action performed when the _findButtonView is pressed.

    Returns

    void

Events

  • change:_areCommandsEnabled( eventInfo, name, value, oldValue )

    See source

    Fired when the _areCommandsEnabled property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_areCommandsEnabled).

    value : Record<string, boolean>

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

    oldValue : Record<string, boolean>

    Old value of the _areCommandsEnabled property with given key or null, if property was not set before.

  • change:_matchCase( eventInfo, name, value, oldValue )

    See source

    Fired when the _matchCase property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_matchCase).

    value : boolean

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

    oldValue : boolean

    Old value of the _matchCase property with given key or null, if property was not set before.

  • change:_resultsCounterText( eventInfo, name, value, oldValue )

    See source

    Fired when the _resultsCounterText property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_resultsCounterText).

    value : string

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

    oldValue : string

    Old value of the _resultsCounterText property with given key or null, if property was not set before.

  • change:_searchResultsFound( eventInfo, name, value, oldValue )

    See source

    Fired when the _searchResultsFound property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_searchResultsFound).

    value : boolean

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

    oldValue : boolean

    Old value of the _searchResultsFound property with given key or null, if property was not set before.

  • change:_wholeWordsOnly( eventInfo, name, value, oldValue )

    See source

    Fired when the _wholeWordsOnly property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_wholeWordsOnly).

    value : boolean

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

    oldValue : boolean

    Old value of the _wholeWordsOnly property with given key or null, if property was not set before.

  • change:highlightOffset( eventInfo, name, value, oldValue )

    See source

    Fired when the highlightOffset property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (highlightOffset).

    value : number

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

    oldValue : number

    Old value of the highlightOffset property with given key or null, if property was not set before.

  • change:isDirty( eventInfo, name, value, oldValue )

    See source

    Fired when the isDirty property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (isDirty).

    value : boolean

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

    oldValue : boolean

    Old value of the isDirty property with given key or null, if property was not set before.

  • change:matchCount( eventInfo, name, value, oldValue )

    See source

    Fired when the matchCount property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (matchCount).

    value : number

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

    oldValue : number

    Old value of the matchCount property with given key or null, if property was not set before.

  • inherited

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

    See source

    Fired when a property changed value.

    observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( '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 : TValue

    The new property value.

    oldValue : TValue

    The previous property value.

  • findNext( eventInfo, [ data ] )

    See source

    Fired when the find next button is triggered.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    [ data ] : FindNextEventData

    The event data.

  • findPrevious( eventInfo, [ data ] )

    See source

    Fired when the find previous button is triggered.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    [ data ] : FindEventBaseData

    The event data.

  • inherited

    render( eventInfo, <anonymous> )

    See source

    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.

    <anonymous> : Parameters<TObservable[ TName ]>

  • replace( eventInfo, data )

    See source

    Fired when the replace button is triggered.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    data : ReplaceEventData

    The event data.

  • replaceAll( eventInfo, data )

    See source

    Fired when the replaceAll button is triggered.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    data : ReplaceEventData

    The event data.

  • set:_areCommandsEnabled( eventInfo, name, value, oldValue )

    See source

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

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_areCommandsEnabled).

    value : Record<string, boolean>

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

    oldValue : Record<string, boolean>

    Old value of the _areCommandsEnabled property with given key or null, if property was not set before.

  • set:_matchCase( eventInfo, name, value, oldValue )

    See source

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

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_matchCase).

    value : boolean

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

    oldValue : boolean

    Old value of the _matchCase property with given key or null, if property was not set before.

  • set:_resultsCounterText( eventInfo, name, value, oldValue )

    See source

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

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_resultsCounterText).

    value : string

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

    oldValue : string

    Old value of the _resultsCounterText property with given key or null, if property was not set before.

  • set:_searchResultsFound( eventInfo, name, value, oldValue )

    See source

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

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_searchResultsFound).

    value : boolean

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

    oldValue : boolean

    Old value of the _searchResultsFound property with given key or null, if property was not set before.

  • set:_wholeWordsOnly( eventInfo, name, value, oldValue )

    See source

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

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (_wholeWordsOnly).

    value : boolean

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

    oldValue : boolean

    Old value of the _wholeWordsOnly property with given key or null, if property was not set before.

  • set:highlightOffset( eventInfo, name, value, oldValue )

    See source

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

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (highlightOffset).

    value : number

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

    oldValue : number

    Old value of the highlightOffset property with given key or null, if property was not set before.

  • set:isDirty( eventInfo, name, value, oldValue )

    See source

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

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (isDirty).

    value : boolean

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

    oldValue : boolean

    Old value of the isDirty property with given key or null, if property was not set before.

  • set:matchCount( eventInfo, name, value, oldValue )

    See source

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

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (matchCount).

    value : number

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

    oldValue : number

    Old value of the matchCount property with given key or null, if property was not set before.

  • inherited

    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<ObservableSetEvent<number>>( '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<ObservableChangeEvent<number>>( '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 : TValue

    The new property value.

    oldValue : TValue

    The previous property value.

  • inherited

    submit( eventInfo )

    See source

    Fired by submitHandler helper.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.