TextareaView
The textarea view class.
const textareaView = new TextareaView();
textareaView.minRows = 2;
textareaView.maxRows = 10;
textareaView.render();
document.body.append( textareaView.element );
Properties
- ariaDescribedById : undefined | stringinherited observable- module:ui/textarea/textareaview~TextareaView#ariaDescribedById- The - idof the element describing this field, e.g. when it has some error; it helps screen readers read the error text.
- ariaLabel : undefined | stringinherited observable- module:ui/textarea/textareaview~TextareaView#ariaLabel- The - aria-labelattribute of the input.
- bindTemplate : BindChain<this>readonlyinherited- module:ui/textarea/textareaview~TextareaView#bindTemplate- 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' ) } } ); } }Copy code
- element : null | HTMLTextAreaElementinherited- module:ui/textarea/textareaview~TextareaView#element- An HTML element of the view. - nulluntil 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 );Copy code- Note: The element of the view can also be assigned directly: - view.element = document.querySelector( '#my-container' );Copy code
- focusTracker : FocusTrackerreadonlyinherited- module:ui/textarea/textareaview~TextareaView#focusTracker- Stores information about the editor UI focus and propagates it so various plugins and components are unified as a focus group. 
- hasError : booleaninherited observable- module:ui/textarea/textareaview~TextareaView#hasError- Set to - truewhen the field has some error. Usually controlled via- errorText.
- id : undefined | stringinherited observable- module:ui/textarea/textareaview~TextareaView#id- The - idattribute of the input (i.e. to pair with a- <label>element).
- isEmpty : boolean- module:ui/textarea/textareaview~TextareaView#isEmpty- An observable flag set to - truewhen the input contains no text, i.e. when- valueis- '',- null, or- false.- Defaults to - true
- isFocused : boolean- module:ui/textarea/textareaview~TextareaView#isFocused- An observable flag set to - truewhen the input is currently focused by the user. Set to- falseotherwise.- Defaults to - false
- isReadOnly : booleaninherited observable- module:ui/textarea/textareaview~TextareaView#isReadOnly- Controls whether the input view is in read-only mode. 
- isRendered : booleanreadonlyinherited- module:ui/textarea/textareaview~TextareaView#isRendered- Set - truewhen the view has already been rendered.
- module:ui/textarea/textareaview~TextareaView#locale
- maxRows : number- module:ui/textarea/textareaview~TextareaView#maxRows
- minRows : number- module:ui/textarea/textareaview~TextareaView#minRows
- placeholder : undefined | stringinherited observable- module:ui/textarea/textareaview~TextareaView#placeholder- The - placeholderattribute of the input.
- resize : 'none' | 'both' | 'horizontal' | 'vertical'- module:ui/textarea/textareaview~TextareaView#resize- Specifies the value of HTML attribute that indicates whether the user can resize the element. - Defaults to - 'none'
- t : undefined | LocaleTranslateinherited- module:ui/textarea/textareaview~TextareaView#t
- tabIndex : undefined | numberinherited observable- module:ui/textarea/textareaview~TextareaView#tabIndex- The - tabindexattribute of the input.
- module:ui/textarea/textareaview~TextareaView#template
- value : undefined | stringinherited observable- module:ui/textarea/textareaview~TextareaView#value- The value of the input. 
- viewUid : string | undefinedinherited- module:ui/textarea/textareaview~TextareaView#viewUid
- _height : null | numberinternal observable- module:ui/textarea/textareaview~TextareaView#_height- An internal property that stores the current height of the textarea. Used for the DOM binding. - Defaults to - null
- _unboundChildren : ViewCollectionprotectedinherited- module:ui/textarea/textareaview~TextareaView#_unboundChildren- A collection of view instances, which have been added directly into the - children.
- _viewCollections : Collection<ViewCollection<View<HTMLElement>>>protectedinherited- module:ui/textarea/textareaview~TextareaView#_viewCollections- Collections registered with - createCollection.
- _isUpdateAutoGrowHeightPending : booleanprivate- module:ui/textarea/textareaview~TextareaView#_isUpdateAutoGrowHeightPending- A flag that indicates whether the - _updateAutoGrowHeightmethod should be called when the view becomes visible again. See- _resizeObserver.
- _resizeObserver : null | ResizeObserverprivate- module:ui/textarea/textareaview~TextareaView#_resizeObserver- An instance of the resize observer used to detect when the view is visible or not and update its height if any changes that affect it were made while it was invisible. - Note: Created in - render.
Methods
- constructor( [ locale ] )- module:ui/textarea/textareaview~TextareaView#constructor
- bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, TextareaView[ K1 ], K2, TextareaView[ K2 ]>inherited- module:ui/textarea/textareaview~TextareaView#bind:DUAL_BIND- Binds observable properties to other objects implementing the - Observableinterface.- Read more in the dedicated guide covering the topic of property bindings with some additional examples. - Consider two objects: a - buttonand an associated- command(both- Observable).- A simple property binding could be as follows: - button.bind( 'isEnabled' ).to( command, 'isEnabled' );Copy code- or even shorter: - button.bind( 'isEnabled' ).to( command );Copy code- which works in the following way: - button.isEnabledinstantly equals- command.isEnabled,
- whenever command.isEnabledchanges,button.isEnabledwill 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' );Copy code- It is possible to bind more than one property at a time to shorten the code: - button.bind( 'isEnabled', 'value' ).to( command );Copy code- which corresponds to: - button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );Copy code- 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 );Copy code- Using a custom callback allows processing the value before passing it to the target property: - button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );Copy code- It is also possible to bind to the same property in an array of observables. To bind a - buttonto 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 );Copy code- 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- ObservableDualBindChain<K1, TextareaView[ K1 ], K2, TextareaView[ K2 ]>
- The bind chain with the - to()and- toMany()methods.
 
- bind( bindProperties ) → ObservableMultiBindChaininherited- module:ui/textarea/textareaview~TextareaView#bind:MANY_BIND- Binds observable properties to other objects implementing the - Observableinterface.- Read more in the dedicated guide covering the topic of property bindings with some additional examples. - Consider two objects: a - buttonand an associated- command(both- Observable).- A simple property binding could be as follows: - button.bind( 'isEnabled' ).to( command, 'isEnabled' );Copy code- or even shorter: - button.bind( 'isEnabled' ).to( command );Copy code- which works in the following way: - button.isEnabledinstantly equals- command.isEnabled,
- whenever command.isEnabledchanges,button.isEnabledwill 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' );Copy code- It is possible to bind more than one property at a time to shorten the code: - button.bind( 'isEnabled', 'value' ).to( command );Copy code- which corresponds to: - button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );Copy code- 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 );Copy code- Using a custom callback allows processing the value before passing it to the target property: - button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );Copy code- It is also possible to bind to the same property in an array of observables. To bind a - buttonto 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 );Copy code- Parameters- bindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'select' | 'template' | 'focus' | 'reset' | 'resize' | 'id' | 'ariaLabel' | 'tabIndex' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'value' | 'isReadOnly' | 'isFocused' | 'placeholder' | 'isEmpty' | 'focusTracker' | 'ariaDescribedById' | 'hasError' | 'minRows' | 'maxRows' | '_height'>
- Observable properties that will be bound to other observable(s). 
 - Returns- ObservableMultiBindChain
- The bind chain with the - to()and- toMany()methods.
 
- bind( bindProperty ) → ObservableSingleBindChain<K, TextareaView[ K ]>inherited- module:ui/textarea/textareaview~TextareaView#bind:SINGLE_BIND- Binds observable properties to other objects implementing the - Observableinterface.- Read more in the dedicated guide covering the topic of property bindings with some additional examples. - Consider two objects: a - buttonand an associated- command(both- Observable).- A simple property binding could be as follows: - button.bind( 'isEnabled' ).to( command, 'isEnabled' );Copy code- or even shorter: - button.bind( 'isEnabled' ).to( command );Copy code- which works in the following way: - button.isEnabledinstantly equals- command.isEnabled,
- whenever command.isEnabledchanges,button.isEnabledwill 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' );Copy code- It is possible to bind more than one property at a time to shorten the code: - button.bind( 'isEnabled', 'value' ).to( command );Copy code- which corresponds to: - button.bind( 'isEnabled' ).to( command ); button.bind( 'value' ).to( command );Copy code- 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 );Copy code- Using a custom callback allows processing the value before passing it to the target property: - button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );Copy code- It is also possible to bind to the same property in an array of observables. To bind a - buttonto 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 );Copy code- Type parameters- K
 - Parameters- bindProperty : K
- Observable property that will be bound to other observable(s). 
 - Returns- ObservableSingleBindChain<K, TextareaView[ K ]>
- The bind chain with the - to()and- toMany()methods.
 
- createCollection( [ views ] ) → ViewCollection<T>inherited- module:ui/textarea/textareaview~TextareaView#createCollection- Creates a new collection of views, which can be used as - childrenof 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 );Copy code- Type parameters- T : extends [object Object] = View
 - Parameters- [ views ] : Iterable<T>
- Initial views of the collection. 
 - Returns- ViewCollection<T>
- A new collection of view instances. 
 
- decorate( methodName ) → voidinherited- module:ui/textarea/textareaview~TextareaView#decorate- 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.Copy code- 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'Copy code- 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'Copy code- Parameters- methodName : 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'select' | 'template' | 'focus' | 'reset' | 'resize' | 'id' | 'ariaLabel' | 'tabIndex' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'value' | 'isReadOnly' | 'isFocused' | 'placeholder' | 'isEmpty' | 'focusTracker' | 'ariaDescribedById' | 'hasError' | 'minRows' | 'maxRows' | '_height'
- Name of the method to decorate. 
 - Returns- void
 
- delegate( events ) → EmitterMixinDelegateChaininherited- module:ui/textarea/textareaview~TextareaView#delegate- Delegates selected events to another - Emitter. For instance:- emitterA.delegate( 'eventX' ).to( emitterB ); emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );Copy code- then - eventXis delegated (fired by)- emitterBand- emitterCalong with- data:- emitterA.fire( 'eventX', data );Copy code- and - eventYis delegated (fired by)- emitterCalong with- data:- emitterA.fire( 'eventY', data );Copy code- Parameters- events : Array<string>
- Event names that will be delegated to another emitter. 
 - Returns
- deregisterChild( children ) → voidinherited- module:ui/textarea/textareaview~TextareaView#deregisterChild- 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- Returns- void
 - Related:
- destroy() → void- module:ui/textarea/textareaview~TextareaView#destroy- Recursively destroys the view instance and child views added by - registerChildand residing in collections created by the- createCollection.- Destruction disables all event listeners: - created on the view, e.g. view.on( 'event', () => {} ),
- defined in the templatefor DOM events.
 - Returns- void
 
- created on the view, e.g. 
- extendTemplate( definition ) → voidinherited- module:ui/textarea/textareaview~TextareaView#extendTemplate- Extends the - templateof the view with with given definition.- A shorthand for: - Template.extend( view.template, definition );Copy code- Note: Is requires the - templateto be already set. See- setTemplate.- Parameters- definition : Partial<TemplateDefinition>
- Definition which extends the - template.
 - Returns- void
 
- fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]inherited- module:ui/textarea/textareaview~TextareaView#fire- Fires an event, executing all callbacks registered for it. - The first parameter passed to callbacks is an - EventInfoobject, followed by the optional- argsprovided in the- fire()method call.- Type parameters- Parameters- eventOrInfo : GetNameOrEventInfo<TEvent>
- The name of the event or - EventInfoobject 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() → voidinherited- module:ui/textarea/textareaview~TextareaView#focus
- listenTo( emitter, event, callback, [ options ] ) → voidinherited- module:ui/textarea/textareaview~TextareaView#listenTo:DOM_EMITTER- 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' );Copy code- An event callback can stop the event and set the return value of the - firemethod.- Type parameters- 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
 
- listenTo( emitter, event, callback, [ options ] ) → voidinherited- module:ui/textarea/textareaview~TextareaView#listenTo:BASE_EMITTER- 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' );Copy code- An event callback can stop the event and set the return value of the - firemethod.- Type parameters- 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
 
- listenTo( emitter, event, callback, [ options ] ) → voidinherited- module:ui/textarea/textareaview~TextareaView#listenTo:HTML_EMITTER- 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 : Window | EventTarget | Node
- The object that fires the event. 
- event : K
- The name of the event. 
- callback : ( this: this, ev: EventInfo, event: DomEventMap[ K ] ) => void
- The function to be called on event. 
- [ options ] : object
- Additional options. 
 - Returns- void
 
- off( event, callback ) → voidinherited- module:ui/textarea/textareaview~TextareaView#off- 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
 
- on( event, callback, [ options ] ) → voidinherited- module:ui/textarea/textareaview~TextareaView#on- 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- 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
 
- once( event, callback, [ options ] ) → voidinherited- module:ui/textarea/textareaview~TextareaView#once- Registers a callback function to be executed on the next time the event is fired only. This is similar to calling - onfollowed by- offin the callback.- Type parameters- 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
 
- registerChild( children ) → voidinherited- module:ui/textarea/textareaview~TextareaView#registerChild- 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 );Copy code- 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- registerChildfor any of them. children: [ this.childA, this.childB ] } ); } // ... }Copy code- Parameters- Returns- void
 
- render() → void- module:ui/textarea/textareaview~TextareaView#render- Recursively renders the view. - Once the view is rendered: - the elementbecomes an HTML element out oftemplate,
- the isRenderedflag is settrue.
 - Note: The children of the view: - defined directly in the template
- residing in collections created by the createCollectionmethod,
- and added by registerChildare also rendered in the process.
 - In general, - render()method is the right place to keep the code which refers to the- elementand should be executed at the very beginning of the view's life cycle.- It is possible to - extendthe- templatebefore 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();Copy code- Returns- void
 
- the 
- reset() → void- module:ui/textarea/textareaview~TextareaView#reset
- select() → voidinherited- module:ui/textarea/textareaview~TextareaView#select
- set( values ) → voidinherited- module:ui/textarea/textareaview~TextareaView#set:OBJECT- 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-overrideerror 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 - declarekeyword. In example:- public declare myProp1: number; public declare myProp2: string; constructor() { this.set( { 'myProp1: 2, 'myProp2: 'foo' } ); }Copy code- Parameters- values : object
- An object with - name=>valuepairs.
 - Returns- void
 
- set( name, value ) → voidinherited- module:ui/textarea/textareaview~TextareaView#set:KEY_VALUE- 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-overrideerror 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 - declarekeyword. In example:- public declare myProp: number; constructor() { this.set( 'myProp', 2 ); }Copy code- Type parameters- K
 - Parameters- name : K
- The property's name. 
- value : TextareaView[ K ]
- The property's value. 
 - Returns- void
 
- setTemplate( definition ) → voidinherited- module:ui/textarea/textareaview~TextareaView#setTemplate- Sets the - templateof the view with with given definition.- A shorthand for: - view.setTemplate( definition );Copy code- Parameters- definition : TemplateDefinition
- Definition of view's template. 
 - Returns- void
 
- stopDelegating( [ event ], [ emitter ] ) → voidinherited- module:ui/textarea/textareaview~TextareaView#stopDelegating- 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- eventto all emitters.
 - Returns- void
 
- stopListening( [ emitter ], [ event ], [ callback ] ) → voidinherited- module:ui/textarea/textareaview~TextareaView#stopListening:BASE_STOP- 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
 
- stopListening( [ emitter ], [ event ], [ callback ] ) → voidinherited- module:ui/textarea/textareaview~TextareaView#stopListening:DOM_STOP- 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 ] : Window | EventTarget | Node | 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
 
- unbind( unbindProperties ) → voidinherited- module:ui/textarea/textareaview~TextareaView#unbind- Removes the binding created with - bind.- // Removes the binding for the 'a' property. A.unbind( 'a' ); // Removes bindings for all properties. A.unbind();Copy code- Parameters- unbindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'select' | 'template' | 'focus' | 'reset' | 'resize' | 'id' | 'ariaLabel' | 'tabIndex' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'value' | 'isReadOnly' | 'isFocused' | 'placeholder' | 'isEmpty' | 'focusTracker' | 'ariaDescribedById' | 'hasError' | 'minRows' | 'maxRows' | '_height'>
- Observable properties to be unbound. All the bindings will be released if no properties are provided. 
 - Returns- void
 
- _updateIsEmpty() → voidprotectedinherited- module:ui/textarea/textareaview~TextareaView#_updateIsEmpty
- _updateAutoGrowHeight( [ shouldScroll ] ) → voidprivate- module:ui/textarea/textareaview~TextareaView#_updateAutoGrowHeight
- _validateMinMaxRows() → voidprivate- module:ui/textarea/textareaview~TextareaView#_validateMinMaxRows
Events
- change:_height( eventInfo, name, value, oldValue )- module:ui/textarea/textareaview~TextareaView#event:change:_height- Fired when the - _heightproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - _height).
- value : null | number
- New value of the - _heightproperty with given key or- null, if operation should remove property.
- oldValue : null | number
- Old value of the - _heightproperty with given key or- null, if property was not set before.
 
- change:ariaDescribedById( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:ariaDescribedById- Fired when the - ariaDescribedByIdproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - ariaDescribedById).
- value : undefined | string
- New value of the - ariaDescribedByIdproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - ariaDescribedByIdproperty with given key or- null, if property was not set before.
 
- change:ariaLabel( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:ariaLabel- Fired when the - ariaLabelproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - ariaLabel).
- value : undefined | string
- New value of the - ariaLabelproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - ariaLabelproperty with given key or- null, if property was not set before.
 
- change:hasError( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:hasError- Fired when the - hasErrorproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - hasError).
- value : boolean
- New value of the - hasErrorproperty with given key or- null, if operation should remove property.
- oldValue : boolean
- Old value of the - hasErrorproperty with given key or- null, if property was not set before.
 
- change:id( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:id- Fired when the - idproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - id).
- value : undefined | string
- New value of the - idproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - idproperty with given key or- null, if property was not set before.
 
- change:isEmpty( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:isEmpty- Fired when the - isEmptyproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - isEmpty).
- value : boolean
- New value of the - isEmptyproperty with given key or- null, if operation should remove property.
- oldValue : boolean
- Old value of the - isEmptyproperty with given key or- null, if property was not set before.
 
- change:isFocused( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:isFocused- Fired when the - isFocusedproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - isFocused).
- value : boolean
- New value of the - isFocusedproperty with given key or- null, if operation should remove property.
- oldValue : boolean
- Old value of the - isFocusedproperty with given key or- null, if property was not set before.
 
- change:isReadOnly( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:isReadOnly- Fired when the - isReadOnlyproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - isReadOnly).
- value : boolean
- New value of the - isReadOnlyproperty with given key or- null, if operation should remove property.
- oldValue : boolean
- Old value of the - isReadOnlyproperty with given key or- null, if property was not set before.
 
- change:maxRows( eventInfo, name, value, oldValue )- module:ui/textarea/textareaview~TextareaView#event:change:maxRows- Fired when the - maxRowsproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - maxRows).
- value : number
- New value of the - maxRowsproperty with given key or- null, if operation should remove property.
- oldValue : number
- Old value of the - maxRowsproperty with given key or- null, if property was not set before.
 
- change:minRows( eventInfo, name, value, oldValue )- module:ui/textarea/textareaview~TextareaView#event:change:minRows- Fired when the - minRowsproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - minRows).
- value : number
- New value of the - minRowsproperty with given key or- null, if operation should remove property.
- oldValue : number
- Old value of the - minRowsproperty with given key or- null, if property was not set before.
 
- change:placeholder( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:placeholder- Fired when the - placeholderproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - placeholder).
- value : undefined | string
- New value of the - placeholderproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - placeholderproperty with given key or- null, if property was not set before.
 
- change:resize( eventInfo, name, value, oldValue )- module:ui/textarea/textareaview~TextareaView#event:change:resize- Fired when the - resizeproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - resize).
- value : 'none' | 'both' | 'horizontal' | 'vertical'
- New value of the - resizeproperty with given key or- null, if operation should remove property.
- oldValue : 'none' | 'both' | 'horizontal' | 'vertical'
- Old value of the - resizeproperty with given key or- null, if property was not set before.
 
- change:tabIndex( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:tabIndex- Fired when the - tabIndexproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - tabIndex).
- value : undefined | number
- New value of the - tabIndexproperty with given key or- null, if operation should remove property.
- oldValue : undefined | number
- Old value of the - tabIndexproperty with given key or- null, if property was not set before.
 
- change:value( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:value- Fired when the - valueproperty changed value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - value).
- value : undefined | string
- New value of the - valueproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - valueproperty with given key or- null, if property was not set before.
 
- change:{property}( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:change:{property}- 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'Copy code- 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. 
 
- render( eventInfo, <anonymous> )inherited- module:ui/textarea/textareaview~TextareaView#event:render
- set:_height( eventInfo, name, value, oldValue )- module:ui/textarea/textareaview~TextareaView#event:set:_height- Fired when the - _heightproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - _height).
- value : null | number
- New value of the - _heightproperty with given key or- null, if operation should remove property.
- oldValue : null | number
- Old value of the - _heightproperty with given key or- null, if property was not set before.
 
- set:ariaDescribedById( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:ariaDescribedById- Fired when the - ariaDescribedByIdproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - ariaDescribedById).
- value : undefined | string
- New value of the - ariaDescribedByIdproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - ariaDescribedByIdproperty with given key or- null, if property was not set before.
 
- set:ariaLabel( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:ariaLabel- Fired when the - ariaLabelproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - ariaLabel).
- value : undefined | string
- New value of the - ariaLabelproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - ariaLabelproperty with given key or- null, if property was not set before.
 
- set:hasError( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:hasError- Fired when the - hasErrorproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - hasError).
- value : boolean
- New value of the - hasErrorproperty with given key or- null, if operation should remove property.
- oldValue : boolean
- Old value of the - hasErrorproperty with given key or- null, if property was not set before.
 
- set:id( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:id- Fired when the - idproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - id).
- value : undefined | string
- New value of the - idproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - idproperty with given key or- null, if property was not set before.
 
- set:isEmpty( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:isEmpty- Fired when the - isEmptyproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - isEmpty).
- value : boolean
- New value of the - isEmptyproperty with given key or- null, if operation should remove property.
- oldValue : boolean
- Old value of the - isEmptyproperty with given key or- null, if property was not set before.
 
- set:isFocused( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:isFocused- Fired when the - isFocusedproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - isFocused).
- value : boolean
- New value of the - isFocusedproperty with given key or- null, if operation should remove property.
- oldValue : boolean
- Old value of the - isFocusedproperty with given key or- null, if property was not set before.
 
- set:isReadOnly( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:isReadOnly- Fired when the - isReadOnlyproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - isReadOnly).
- value : boolean
- New value of the - isReadOnlyproperty with given key or- null, if operation should remove property.
- oldValue : boolean
- Old value of the - isReadOnlyproperty with given key or- null, if property was not set before.
 
- set:maxRows( eventInfo, name, value, oldValue )- module:ui/textarea/textareaview~TextareaView#event:set:maxRows- Fired when the - maxRowsproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - maxRows).
- value : number
- New value of the - maxRowsproperty with given key or- null, if operation should remove property.
- oldValue : number
- Old value of the - maxRowsproperty with given key or- null, if property was not set before.
 
- set:minRows( eventInfo, name, value, oldValue )- module:ui/textarea/textareaview~TextareaView#event:set:minRows- Fired when the - minRowsproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - minRows).
- value : number
- New value of the - minRowsproperty with given key or- null, if operation should remove property.
- oldValue : number
- Old value of the - minRowsproperty with given key or- null, if property was not set before.
 
- set:placeholder( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:placeholder- Fired when the - placeholderproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - placeholder).
- value : undefined | string
- New value of the - placeholderproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - placeholderproperty with given key or- null, if property was not set before.
 
- set:resize( eventInfo, name, value, oldValue )- module:ui/textarea/textareaview~TextareaView#event:set:resize- Fired when the - resizeproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - resize).
- value : 'none' | 'both' | 'horizontal' | 'vertical'
- New value of the - resizeproperty with given key or- null, if operation should remove property.
- oldValue : 'none' | 'both' | 'horizontal' | 'vertical'
- Old value of the - resizeproperty with given key or- null, if property was not set before.
 
- set:tabIndex( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:tabIndex- Fired when the - tabIndexproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - tabIndex).
- value : undefined | number
- New value of the - tabIndexproperty with given key or- null, if operation should remove property.
- oldValue : undefined | number
- Old value of the - tabIndexproperty with given key or- null, if property was not set before.
 
- set:value( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:value- Fired when the - valueproperty is going to be set but is not set yet (before the- changeevent is fired).- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
- name : string
- Name of the changed property ( - value).
- value : undefined | string
- New value of the - valueproperty with given key or- null, if operation should remove property.
- oldValue : undefined | string
- Old value of the - valueproperty with given key or- null, if property was not set before.
 
- set:{property}( eventInfo, name, value, oldValue )inherited- module:ui/textarea/textareaview~TextareaView#event:set:{property}- Fired when a property value is going to be set but is not set yet (before the - changeevent is fired).- You can control the final value of the property by using the event's - returnproperty.- 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'Copy code- 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. 
 
- submit( eventInfo )inherited- module:ui/textarea/textareaview~TextareaView#event:submit- Fired by - submitHandlerhelper.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event. 
 
- update( eventInfo )- module:ui/textarea/textareaview~TextareaView#event:update- Fired every time the layout of the - TextareaViewpossibly changed as a result of the user input or the value change via- value.- Parameters- eventInfo : EventInfo
- An object containing information about the fired event.