FileDialogButtonView

class

The file dialog button view.

This component provides a button that opens the native file selection dialog. It can be used to implement the UI of a file upload feature.

const view = new FileDialogButtonView( locale );

view.set( {
	acceptedType: 'image/*',
	allowMultipleFiles: true
	label: t( 'Insert image' ),
	icon: imageIcon,
	tooltip: true
} );

view.on( 'done', ( evt, files ) => {
	for ( const file of Array.from( files ) ) {
		console.log( 'Selected file', file );
	}
} );

See source

Properties

acceptedType : string
inheritedobservable

module:ui/button/filedialogbuttonview~FileDialogButtonView#acceptedType
Accepted file types. Can be provided in form of file extensions, media type or one of:
- audio/*,
- video/*,
- image/*.
See source (with github icon)
allowMultipleFiles : boolean
inheritedobservable

Indicates if multiple files can be selected. Defaults to true.

See source (with github icon)
ariaLabel : string | undefined
inherited

See source (with github icon)
ariaLabelledBy : undefined | string
inherited

See source (with github icon)

`bindTemplate : BindChain<this>`
readonlyinherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#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' )
			}
		} );
	}
}

See source

children : ViewCollection
readonlyinherited

Collection of the child views inside of the button element.

See source (with github icon)
class : undefined | string
inherited

See source (with github icon)

`element : null | object`
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#element

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

See source

icon : undefined | string
inherited

See source (with github icon)
iconView : IconView
readonlyinherited

The icon view of the button. Will be added to children when the icon attribute is defined.

See source (with github icon)
isEnabled : boolean
inherited

See source (with github icon)
isOn : boolean
inherited

See source (with github icon)
isRendered : boolean
readonlyinherited

Set true when the view has already been rendered.

See source (with github icon)
isToggleable : boolean
inherited

See source (with github icon)
isVisible : boolean
inherited

See source (with github icon)
keystroke : undefined | string
inherited

See source (with github icon)
keystrokeView : View
readonlyinherited

A view displaying the keystroke of the button next to the label. Added to children when the withKeystroke attribute is defined.

See source (with github icon)
label : undefined | string
inherited

See source (with github icon)
labelStyle : undefined | string
inherited

See source (with github icon)
labelView : ButtonLabel
readonlyinherited

Label of the button view. Its text is configurable using the label attribute.

If not configured otherwise in the constructor(), by default the label is an instance of ButtonLabelView.

See source (with github icon)
locale : undefined | Locale
readonlyinherited

A set of tools to localize the user interface.

Also see locale.

See source (with github icon)
role : undefined | string
inherited

See source (with github icon)
t : undefined | LocaleTranslate
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#t
Shorthand for t.

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

See source (with github icon)

Related:
- Locale#t
tabindex : number
inherited

See source (with github icon)
template : Template | undefined
inherited

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

See source (with github icon)
tooltip : string | boolean | ( label: string, keystroke: undefined | string ) => string
inherited

See source (with github icon)
tooltipPosition : 'e' | 's' | 'n' | 'w' | 'sw' | 'se'
inherited

See source (with github icon)
type : 'button' | 'menu' | 'reset' | 'submit'
inherited

See source (with github icon)
viewUid : string | undefined
inherited

See source (with github icon)
withKeystroke : boolean
inherited

See source (with github icon)
withText : boolean
inherited

See source (with github icon)
_ariaChecked : string | false
internalreadonlyinherited

Aria-checked attribute of element. It is calculated based on isToggleable and role. It's set to true if the button is on and the role is checkable.

See source (with github icon)
_ariaPressed : string | false
internalreadonlyinherited

Aria-pressed attribute of element. It is calculated based on isToggleable and role. It's set to true if the button is on and the role is not checkable.

See source (with github icon)
_tooltipString : string
internalinheritedobservable

module:ui/button/filedialogbuttonview~FileDialogButtonView#_tooltipString
Tooltip of the button bound to the template.

See source (with github icon)

Related:
- FileDialogButtonView#tooltip
- ButtonView#_getTooltipString
_unboundChildren : ViewCollection
protectedinherited

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

See source (with github icon)
_viewCollections : Collection<ViewCollection<View<HTMLElement>>>
protectedinherited

Collections registered with createCollection.

See source (with github icon)

Methods

constructor( args )
inherited

See source (with github icon)

Parameters

args : tuple
bind( bindProperties ) → ObservableMultiBindChain
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#bind:MANY_BIND
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' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
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' );
```
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 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 );
```
Copy code
See source (with github icon)

Parameters

bindProperties : Array<'type' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'label' | 'template' | 'focus' | 'ariaLabel' | 'role' | 'children' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'class' | 'tabindex' | 'keystroke' | 'isVisible' | 'tooltip' | 'tooltipPosition' | '_ariaPressed' | 'labelView' | 'iconView' | 'keystrokeView' | 'labelStyle' | 'icon' | 'isEnabled' | 'isOn' | 'isToggleable' | 'withText' | 'withKeystroke' | 'ariaLabelledBy' | '_ariaChecked' | '_tooltipString' | 'acceptedType' | 'allowMultipleFiles'>

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

Returns

ObservableMultiBindChain

The bind chain with the to() and toMany() methods.
bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, FileDialogButtonView[ K1 ], K2, FileDialogButtonView[ K2 ]>
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#bind:DUAL_BIND
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' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
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' );
```
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 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 );
```
Copy code
See source (with github icon)

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, FileDialogButtonView[ K1 ], K2, FileDialogButtonView[ K2 ]>

The bind chain with the to() and toMany() methods.
bind( bindProperty ) → ObservableSingleBindChain<K, FileDialogButtonView[ K ]>
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#bind:SINGLE_BIND
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' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
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' );
```
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 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 );
```
Copy code
See source (with github icon)

Type parameters

K

Parameters

bindProperty : K

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

Returns

ObservableSingleBindChain<K, FileDialogButtonView[ K ]>

The bind chain with the to() and toMany() methods.
createCollection( [ views ] ) → ViewCollection<T>
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#createCollection
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 );
```
Copy code
See source (with github icon)

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

module:ui/button/filedialogbuttonview~FileDialogButtonView#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
See source (with github icon)

Parameters

methodName : 'type' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'label' | 'template' | 'focus' | 'ariaLabel' | 'role' | 'children' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'class' | 'tabindex' | 'keystroke' | 'isVisible' | 'tooltip' | 'tooltipPosition' | '_ariaPressed' | 'labelView' | 'iconView' | 'keystrokeView' | 'labelStyle' | 'icon' | 'isEnabled' | 'isOn' | 'isToggleable' | 'withText' | 'withKeystroke' | 'ariaLabelledBy' | '_ariaChecked' | '_tooltipString' | 'acceptedType' | 'allowMultipleFiles'

Name of the method to decorate.

Returns

void
delegate( events ) → EmitterMixinDelegateChain
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#delegate
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Copy code
See source (with github icon)

Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
deregisterChild( children ) → void
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#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.

See source (with github icon)

Parameters

children : View<HTMLElement> | Iterable<View<HTMLElement>>

Child views to be removed.

Returns

void

Related:
- FileDialogButtonView#registerChild
destroy() → void
inherited

See source (with github icon)

Returns

void
extendTemplate( definition ) → void
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#extendTemplate
Extends the template of the view with with given definition.

A shorthand for:
```
Template.extend( view.template, definition );
```
Copy code
Note: Is requires the template to be already set. See setTemplate.

See source (with github icon)

Parameters

definition : Partial<TemplateDefinition>

Definition which extends the template.

Returns

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

Fires an event, executing all callbacks registered for it.

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

See source (with github icon)

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
inherited

Focuses the element of the button.

See source (with github icon)

Returns

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

module:ui/button/filedialogbuttonview~FileDialogButtonView#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 fire method.

See source (with github icon)

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
listenTo( emitter, event, callback, [ options ] ) → void
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#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 fire method.

See source (with github icon)

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
listenTo( emitter, event, callback, [ options ] ) → void
inherited

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.

See source (with github icon)

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

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

See source (with github icon)

Parameters

event : string

The name of the event.

callback : Function

The function to stop being called.

Returns

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

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

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

See source (with github icon)

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
once( event, callback, [ options ] ) → void
inherited

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

See source (with github icon)

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

`registerChild( children ) → void`
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#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 );

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

	// ...
}

See source

Parameters

children : View<HTMLElement> | Iterable<View<HTMLElement>>: Children views to be registered.

Returns

void

render() → void
inherited

See source (with github icon)

Returns

void
set( values ) → void
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#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-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'
	} );
}
```
Copy code
See source (with github icon)

Parameters

values : object

An object with name=>value pairs.

Returns

void
set( name, value ) → void
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#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-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 );
}
```
Copy code
See source (with github icon)

Type parameters

K

Parameters

name : K

The property's name.

value : FileDialogButtonView[ K ]

The property's value.

Returns

void
setTemplate( definition ) → void
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#setTemplate
Sets the template of the view with with given definition.

A shorthand for:
```
view.setTemplate( definition );
```
Copy code
See source (with github icon)

Parameters

definition : TemplateDefinition

Definition of view's template.

Returns

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

module:ui/button/filedialogbuttonview~FileDialogButtonView#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.
See source (with github icon)

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
stopListening( [ emitter ], [ event ], [ callback ] ) → void
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#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.
See source (with github icon)

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 ] ) → void
inherited

module:ui/button/filedialogbuttonview~FileDialogButtonView#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.
See source (with github icon)

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

module:ui/button/filedialogbuttonview~FileDialogButtonView#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
See source (with github icon)

Parameters

unbindProperties : Array<'type' | 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'element' | 'label' | 'template' | 'focus' | 'ariaLabel' | 'role' | 'children' | 'isRendered' | 'locale' | 't' | 'viewUid' | 'bindTemplate' | 'createCollection' | 'registerChild' | 'deregisterChild' | 'setTemplate' | 'extendTemplate' | 'render' | 'destroy' | 'class' | 'tabindex' | 'keystroke' | 'isVisible' | 'tooltip' | 'tooltipPosition' | '_ariaPressed' | 'labelView' | 'iconView' | 'keystrokeView' | 'labelStyle' | 'icon' | 'isEnabled' | 'isOn' | 'isToggleable' | 'withText' | 'withKeystroke' | 'ariaLabelledBy' | '_ariaChecked' | '_tooltipString' | 'acceptedType' | 'allowMultipleFiles'>

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

Returns

void

Events

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

Fired when the _tooltipString property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (_tooltipString).

value : string

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

oldValue : string

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

Fired when the acceptedType property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (acceptedType).

value : string

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

oldValue : string

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

Fired when the allowMultipleFiles property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (allowMultipleFiles).

value : boolean

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

oldValue : boolean

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

Fired when the ariaLabel property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (ariaLabel).

value : string

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

oldValue : string

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

Fired when the ariaLabelledBy property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (ariaLabelledBy).

value : undefined | string

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

oldValue : undefined | string

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

Fired when the class property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (class).

value : undefined | string

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

oldValue : undefined | string

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

Fired when the icon property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (icon).

value : undefined | string

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

oldValue : undefined | string

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

Fired when the isEnabled property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isEnabled).

value : boolean

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

oldValue : boolean

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

Fired when the isOn property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isOn).

value : boolean

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

oldValue : boolean

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

Fired when the isToggleable property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isToggleable).

value : boolean

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

oldValue : boolean

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

Fired when the isVisible property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isVisible).

value : boolean

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

oldValue : boolean

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

Fired when the keystroke property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (keystroke).

value : undefined | string

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

oldValue : undefined | string

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

Fired when the label property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (label).

value : undefined | string

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

oldValue : undefined | string

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

Fired when the labelStyle property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (labelStyle).

value : undefined | string

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

oldValue : undefined | string

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

Fired when the role property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (role).

value : undefined | string

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

oldValue : undefined | string

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

Fired when the tabindex property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (tabindex).

value : number

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

oldValue : number

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

Fired when the tooltip property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (tooltip).

value : string | boolean | ( label: string, keystroke: undefined | string ) => string

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

oldValue : string | boolean | ( label: string, keystroke: undefined | string ) => string

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

Fired when the tooltipPosition property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (tooltipPosition).

value : 'e' | 's' | 'n' | 'w' | 'sw' | 'se'

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

oldValue : 'e' | 's' | 'n' | 'w' | 'sw' | 'se'

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

Fired when the type property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (type).

value : 'button' | 'menu' | 'reset' | 'submit'

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

oldValue : 'button' | 'menu' | 'reset' | 'submit'

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

Fired when the withKeystroke property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (withKeystroke).

value : boolean

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

oldValue : boolean

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

Fired when the withText property changed value.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (withText).

value : boolean

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

oldValue : boolean

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

module:ui/button/filedialogbuttonview~FileDialogButtonView#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
See source (with github icon)

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

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.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : Parameters<TObservable[ TName ]>
set:_tooltipString( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (_tooltipString).

value : string

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

oldValue : string

Old value of the _tooltipString property with given key or null, if property was not set before.
set:acceptedType( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (acceptedType).

value : string

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

oldValue : string

Old value of the acceptedType property with given key or null, if property was not set before.
set:allowMultipleFiles( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (allowMultipleFiles).

value : boolean

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

oldValue : boolean

Old value of the allowMultipleFiles property with given key or null, if property was not set before.
set:ariaLabel( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (ariaLabel).

value : string

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

oldValue : string

Old value of the ariaLabel property with given key or null, if property was not set before.
set:ariaLabelledBy( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (ariaLabelledBy).

value : undefined | string

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

oldValue : undefined | string

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

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (class).

value : undefined | string

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

oldValue : undefined | string

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

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (icon).

value : undefined | string

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

oldValue : undefined | string

Old value of the icon property with given key or null, if property was not set before.
set:isEnabled( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isEnabled).

value : boolean

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

oldValue : boolean

Old value of the isEnabled property with given key or null, if property was not set before.
set:isOn( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isOn).

value : boolean

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

oldValue : boolean

Old value of the isOn property with given key or null, if property was not set before.
set:isToggleable( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isToggleable).

value : boolean

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

oldValue : boolean

Old value of the isToggleable property with given key or null, if property was not set before.
set:isVisible( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isVisible).

value : boolean

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

oldValue : boolean

Old value of the isVisible property with given key or null, if property was not set before.
set:keystroke( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (keystroke).

value : undefined | string

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

oldValue : undefined | string

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

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (label).

value : undefined | string

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

oldValue : undefined | string

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

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (labelStyle).

value : undefined | string

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

oldValue : undefined | string

Old value of the labelStyle property with given key or null, if property was not set before.
set:role( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (role).

value : undefined | string

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

oldValue : undefined | string

Old value of the role property with given key or null, if property was not set before.
set:tabindex( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (tabindex).

value : number

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

oldValue : number

Old value of the tabindex property with given key or null, if property was not set before.
set:tooltip( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (tooltip).

value : string | boolean | ( label: string, keystroke: undefined | string ) => string

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

oldValue : string | boolean | ( label: string, keystroke: undefined | string ) => string

Old value of the tooltip property with given key or null, if property was not set before.
set:tooltipPosition( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (tooltipPosition).

value : 'e' | 's' | 'n' | 'w' | 'sw' | 'se'

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

oldValue : 'e' | 's' | 'n' | 'w' | 'sw' | 'se'

Old value of the tooltipPosition property with given key or null, if property was not set before.
set:type( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (type).

value : 'button' | 'menu' | 'reset' | 'submit'

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

oldValue : 'button' | 'menu' | 'reset' | 'submit'

Old value of the type property with given key or null, if property was not set before.
set:withKeystroke( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (withKeystroke).

value : boolean

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

oldValue : boolean

Old value of the withKeystroke property with given key or null, if property was not set before.
set:withText( eventInfo, name, value, oldValue )
inherited

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

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (withText).

value : boolean

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

oldValue : boolean

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

module:ui/button/filedialogbuttonview~FileDialogButtonView#event:set:{property}
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'
```
Copy code
Note: The event is fired even when the new value is the same as the old value.

See source (with github icon)

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

Fired by submitHandler helper.

See source (with github icon)

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

FileDialogButtonView

Properties

acceptedType : string inherited Eye icon observable

allowMultipleFiles : boolean inherited Eye icon observable

ariaLabel : string | undefined inherited

ariaLabelledBy : undefined | string inherited

bindTemplate : BindChain<this> readonlyinherited

children : ViewCollection readonlyinherited

class : undefined | string inherited

element : null | object inherited

icon : undefined | string inherited

iconView : IconView readonlyinherited

isEnabled : boolean inherited

isOn : boolean inherited

isRendered : boolean readonlyinherited

isToggleable : boolean inherited

isVisible : boolean inherited

keystroke : undefined | string inherited

keystrokeView : View readonlyinherited

label : undefined | string inherited

labelStyle : undefined | string inherited

labelView : ButtonLabel readonlyinherited

locale : undefined | Locale readonlyinherited

role : undefined | string inherited

t : undefined | LocaleTranslate inherited

Related:

tabindex : number inherited

template : Template | undefined inherited

tooltip : string | boolean | ( label: string, keystroke: undefined | string ) => string inherited

tooltipPosition : 'e' | 's' | 'n' | 'w' | 'sw' | 'se' inherited

type : 'button' | 'menu' | 'reset' | 'submit' inherited

viewUid : string | undefined inherited

withKeystroke : boolean inherited

withText : boolean inherited

_ariaChecked : string | false internalreadonlyinherited

_ariaPressed : string | false internalreadonlyinherited

_tooltipString : string internalinherited Eye icon observable

Related:

_unboundChildren : ViewCollection protectedinherited

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

Methods

constructor( args ) inherited

Parameters

bind( bindProperties ) → ObservableMultiBindChain inherited

Parameters

Returns

bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, FileDialogButtonView[ K1 ], K2, FileDialogButtonView[ K2 ]> inherited

Type parameters

Parameters

Returns

bind( bindProperty ) → ObservableSingleBindChain<K, FileDialogButtonView[ K ]> inherited

Type parameters

Parameters

Returns

createCollection( [ views ] ) → ViewCollection<T> inherited

Type parameters

Parameters

Returns

decorate( methodName ) → void inherited

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChain inherited

Parameters

Returns

deregisterChild( children ) → void inherited

Parameters

Returns

Related:

destroy() → void inherited

Returns

extendTemplate( definition ) → void inherited

Parameters

Returns

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

Type parameters

Parameters

Returns

focus() → void inherited

Returns

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

`acceptedType : string`
inheritedobservable

`allowMultipleFiles : boolean`
inheritedobservable

`ariaLabel : string | undefined`
inherited

`ariaLabelledBy : undefined | string`
inherited

`bindTemplate : BindChain<this>`
readonlyinherited

`children : ViewCollection`
readonlyinherited

`class : undefined | string`
inherited

`element : null | object`
inherited

`icon : undefined | string`
inherited

`iconView : IconView`
readonlyinherited

`isEnabled : boolean`
inherited

`isOn : boolean`
inherited

`isRendered : boolean`
readonlyinherited

`isToggleable : boolean`
inherited

`isVisible : boolean`
inherited

`keystroke : undefined | string`
inherited

`keystrokeView : View`
readonlyinherited

`label : undefined | string`
inherited

`labelStyle : undefined | string`
inherited

`labelView : ButtonLabel`
readonlyinherited

`locale : undefined | Locale`
readonlyinherited

`role : undefined | string`
inherited

`t : undefined | LocaleTranslate`
inherited

`tabindex : number`
inherited

`template : Template | undefined`
inherited

`tooltip : string | boolean | ( label: string, keystroke: undefined | string ) => string`
inherited

`tooltipPosition : 'e' | 's' | 'n' | 'w' | 'sw' | 'se'`
inherited

`type : 'button' | 'menu' | 'reset' | 'submit'`
inherited

`viewUid : string | undefined`
inherited

`withKeystroke : boolean`
inherited

`withText : boolean`
inherited

`_ariaChecked : string | false`
internalreadonlyinherited

`_ariaPressed : string | false`
internalreadonlyinherited

`_tooltipString : string`
internalinheritedobservable

`_unboundChildren : ViewCollection`
protectedinherited

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

`constructor( args )`
inherited

`bind( bindProperties ) → ObservableMultiBindChain`
inherited

`bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, FileDialogButtonView[ K1 ], K2, FileDialogButtonView[ K2 ]>`
inherited

`bind( bindProperty ) → ObservableSingleBindChain<K, FileDialogButtonView[ K ]>`
inherited

`createCollection( [ views ] ) → ViewCollection<T>`
inherited

`decorate( methodName ) → void`
inherited

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`deregisterChild( children ) → void`
inherited

`destroy() → void`
inherited

`extendTemplate( definition ) → void`
inherited

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

`focus() → void`
inherited

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

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

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

`off( event, callback ) → void`
inherited

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

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

`registerChild( children ) → void`
inherited

`render() → void`
inherited

`set( values ) → void`
inherited

`set( name, value ) → void`
inherited

`setTemplate( definition ) → void`
inherited

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

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

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

`unbind( unbindProperties ) → void`
inherited

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

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

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

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

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

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

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

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

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

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