Readonly Internal_Aria-checked attribute of element. It is calculated based on #isToggleable isToggleable and #role. It's set to true if the button is on and the role is checkable.
Readonly Internal_Aria-pressed attribute of element. It is calculated based on #isToggleable isToggleable and #role. It's set to true if the button is on and the role is not checkable.
Readonly Internal_The flag that indicates if the button should render a check holder.
Internal_Tooltip of the button bound to the template.
Protected_A collection of view instances, which have been added directly into the module:ui/template~Template#children.
Protected_Collections registered with #createCollection.
Optionalaria(Optional) The ARIA property reflected by the aria-label DOM attribute used by assistive technologies.
(Optional) The ARIA property reflected by the aria-ariaLabelledBy DOM attribute used by assistive technologies.
ReadonlychildrenCollection of the child views inside of the button #element.
(Optional) The additional CSS class set on the button.
An HTML element of the view. null until #render 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' );
Indicates whether the button view has reserved space for a check holder.
(Optional) An XML module:ui/icon/iconview~IconView#content content of the icon.
When defined, an iconView should be added to the button.
The user must provide the entire XML string, not just the path. See the {@glink framework/architecture/ui-library#setting-label-icon-and-tooltip UI library} guide for details.
ReadonlyiconThe icon view of the button. Will be added to #children when the #icon icon attribute is defined.
Controls whether the button view is enabled, i.e. it can be clicked and execute an action.
To change the "on" state of the button, use #isOn instead.
Controls whether the button view is "on". It makes sense when a feature it represents is currently active, e.g. a bold button is "on" when the selection is in the bold text.
To disable the button, use #isEnabled instead.
ReadonlyisSet true when the view has already been module:ui/view~View#render rendered.
Controls whether the button view is a toggle button (two–state) for assistive technologies.
Controls whether the button view is visible. Visible by default, buttons are hidden using a CSS class.
(Optional) The keystroke associated with the button, i.e. CTRL+B, in the string format compatible with module:utils/keyboard.
Note: Use module:ui/button/button~Button#withKeystroke if you want to display the keystroke information next to the module:ui/button/button~Button#label label.
ReadonlykeystrokeA view displaying the keystroke of the button next to the #labelView label.
Added to #children when the #withKeystroke withKeystroke attribute
is defined.
The label of the button view visible to the user when #withText is true.
It can also be used to create a #tooltip.
(Optional) The value of the style attribute of the label.
ReadonlylabelLabel of the button view. Its text is configurable using the #label label attribute.
If not configured otherwise in the constructor(), by default the label is an instance
of module:ui/button/buttonlabelview~ButtonLabelView.
ReadonlylocaleA set of tools to localize the user interface.
Also see module:core/editor/editor~Editor#locale.
(Optional) The property reflected by the role DOM attribute to be used by assistive technologies.
Shorthand for module:utils/locale~Locale#t.
Note: If #locale instance hasn't been passed to the view this method may not be available.
(Optional) Controls the tabindex HTML attribute of the button. By default, the button is focusable
but does not included in the Tab order.
OptionaltemplateTemplate of this view. It provides the #element representing the view in DOM, which is #render rendered.
(Optional) Tooltip of the button, i.e. displayed when hovering the button with the mouse cursor.
Boolean (e.g. true), then combination of label and keystroke will be set as a tooltip.String, tooltip will equal the exact text of that String.Function, label and keystroke will be passed to that function, which is to return
a string with the tooltip text.const view = new ButtonView( locale );
view.tooltip = ( label, keystroke ) => `A tooltip for ${ label } and ${ keystroke }.`
(Optional) The position of the tooltip. See module:ui/tooltipmanager~TooltipManager to learn more about the tooltip system.
Note: It makes sense only when the #tooltip tooltip attribute is defined.
The HTML type of the button.
Optionalview(Optional) Controls whether the keystroke of the button is displayed next to its module:ui/button/button~Button#label label.
Note: This property requires a module:ui/button/button~Button#keystroke keystroke to be defined in the first place.
(Optional) Controls whether the label of the button is hidden (e.g. an icon–only button).
Shorthand for module:ui/template~Template.bind, a binding module:ui/template~BindChain interface pre–configured for the view instance.
It provides module:ui/template~BindChain#to to() and
module:ui/template~BindChain#if 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 {@link module:utils/observablemixin~Observable 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' )
}
} );
}
}
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings dedicated} guide covering the topic of property bindings with some additional examples.
Consider two objects: a button and an associated command (both Observable).
A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled instantly equals command.isEnabled,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#unbind.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
button.bind( 'isEnabled' ).to( command, 'isWorking' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables.
To bind a button to multiple commands (also Observables) so that each and every one of them
must be enabled for the button to become enabled, use the following code:
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
Observable property that will be bound to other observable(s).
The bind chain with the to() and toMany() methods.
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings dedicated} guide covering the topic of property bindings with some additional examples.
Consider two objects: a button and an associated command (both Observable).
A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled instantly equals command.isEnabled,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#unbind.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
button.bind( 'isEnabled' ).to( command, 'isWorking' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables.
To bind a button to multiple commands (also Observables) so that each and every one of them
must be enabled for the button to become enabled, use the following code:
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
The bind chain with the to() and toMany() methods.
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings dedicated} guide covering the topic of property bindings with some additional examples.
Consider two objects: a button and an associated command (both Observable).
A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled instantly equals command.isEnabled,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#unbind.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
button.bind( 'isEnabled' ).to( command, 'isWorking' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables.
To bind a button to multiple commands (also Observables) so that each and every one of them
must be enabled for the button to become enabled, use the following code:
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
Observable properties that will be bound to other observable(s).
The bind chain with the to() and toMany() methods.
Creates a new collection of views, which can be used as module:ui/template~Template#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 );
A new collection of view instances.
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 {@glink framework/deep-dive/observables#decorating-object-methods 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 module:utils/eventinfo~EventInfo#stop stopped:
class Foo extends ObservableMixin() {
constructor() {
super();
this.decorate( 'method' );
}
method() {
console.log( 'called!' );
}
}
const foo = new Foo();
foo.on( 'method', ( evt ) => {
evt.stop();
}, { priority: 'high' } );
foo.method(); // Nothing is logged.
Note: The high module:utils/priorities~PriorityString priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).
It is also possible to change the returned value:
foo.on( 'method', ( evt ) => {
evt.return = 'Foo!';
} );
foo.method(); // -> 'Foo'
Finally, it is possible to access and modify the arguments the method is called with:
method( a, b ) {
console.log( `${ a }, ${ b }` );
}
// ...
foo.on( 'method', ( evt, args ) => {
args[ 0 ] = 3;
console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );
foo.method( 1, 2 ); // -> '3, 2'
Name of the method to decorate.
Delegates selected events to another module:utils/emittermixin~Emitter. For instance:
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
then eventX is delegated (fired by) emitterB and emitterC along with data:
emitterA.fire( 'eventX', data );
and eventY is delegated (fired by) emitterC along with data:
emitterA.fire( 'eventY', data );
Event names that will be delegated to another emitter.
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.
Child views to be removed.
Recursively destroys the view instance and child views added by #registerChild and residing in collections created by the #createCollection.
Destruction disables all event listeners:
view.on( 'event', () => {} ),module:ui/template~Template.extend Extends the #template of the view with with given definition.
A shorthand for:
Template.extend( view.template, definition );
Note: Is requires the #template to be already set. See #setTemplate.
Definition which extends the #template.
Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an module:utils/eventinfo~EventInfo object,
followed by the optional args provided in the fire() method call.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The name of the event or EventInfo object if event is delegated.
Additional arguments to be passed to the callbacks.
By default the method returns undefined. However, the return value can be changed by listeners
through modification of the module:utils/eventinfo~EventInfo#return evt.return's property (the event info
is the first param of every callback).
Focuses the #element of the button.
Registers a callback function to be executed when an event is fired in a specific Emitter or DOM Node. It is backwards compatible with module:utils/emittermixin~Emitter#listenTo.
The object that fires the event.
The name of the event.
The function to be called on event.
Optionaloptions: CallbackOptions & { useCapture?: boolean; usePassive?: boolean }Additional options.
Optional ReadonlyuseCapture?: booleanIndicates that events of this type will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree.
Optional ReadonlyusePassive?: booleanIndicates that the function specified by listener will never call preventDefault() and prevents blocking browser's main thread by this event handler.
Registers a callback function to be executed when an event is fired in a specific (emitter) object.
Events can be grouped in namespaces using :.
When namespaced event is fired, it additionally fires all callbacks for that namespace.
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );
// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
An event callback can module:utils/eventinfo~EventInfo#stop stop the event and set the module:utils/eventinfo~EventInfo#return return value of the #fire method.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The object that fires the event.
The name of the event.
The function to be called on event.
Optionaloptions: CallbackOptionsAdditional options.
Registers a callback function to be executed when an event is fired in a specific (emitter) object.
Events can be grouped in namespaces using :.
When namespaced event is fired, it additionally fires all callbacks for that namespace.
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );
// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
An event callback can module:utils/eventinfo~EventInfo#stop stop the event and set the module:utils/eventinfo~EventInfo#return return value of the #fire method.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The object that fires the event.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
Stops executing the callback on the given event.
Shorthand for #stopListening this.stopListening( this, event, callback ).
The name of the event.
The function to stop being called.
Registers a callback function to be executed when an event is fired.
Shorthand for #listenTo this.listenTo( this, event, callback, options ) (it makes the emitter
listen on itself).
The type descibing the event. See module:utils/emittermixin~BaseEvent.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
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.
The type descibing the event. See module:utils/emittermixin~BaseEvent.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
Registers a new child view under the view instance. Once registered, a child view is managed by its parent, including #render rendering and #destroy 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 {@link #registerChild} for any of them.
children: [ this.childA, this.childB ]
} );
}
// ...
}
Children views to be registered.
Recursively renders the view.
Once the view is rendered:
true.Note: The children of the view:
In general, render() method is the right place to keep the code which refers to the
#element and should be executed at the very beginning of the view's life cycle.
It is possible to module:ui/template~Template.extend the #template before
the view is rendered. To allow an early customization of the view (e.g. by its parent),
such references should be done in render().
class SampleView extends View {
constructor() {
this.setTemplate( {
// ...
} );
},
render() {
// View#element becomes available.
super.render();
// The "scroll" listener depends on #element.
this.listenTo( window, 'scroll', () => {
// A reference to #element would render the #template and make it non-extendable.
if ( window.scrollY > 0 ) {
this.element.scrollLeft = 100;
} else {
this.element.scrollLeft = 0;
}
} );
}
}
const view = new SampleView();
// Let's customize the view before it gets rendered.
view.extendTemplate( {
attributes: {
class: [
'additional-class'
]
}
} );
// Late rendering allows customization of the view.
view.render();
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 );
}
The property's name.
The property's value.
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'
} );
}
An object with name=>value pairs.
Optional Readonly Internal_ariaChecked?: unknownAria-checked attribute of element. It is calculated based on #isToggleable isToggleable and #role. It's set to true if the button is on and the role is checkable.
Optional Readonly Internal_ariaPressed?: unknownAria-pressed attribute of element. It is calculated based on #isToggleable isToggleable and #role. It's set to true if the button is on and the role is not checkable.
Optional Readonly Internal_hasCheck?: unknownThe flag that indicates if the button should render a check holder.
Optional Readonly Internal_tooltipString?: unknownTooltip of the button bound to the template.
Optional ReadonlyariaLabel?: unknownOptional ReadonlyariaLabelledBy?: unknownOptionalbind?: unknownOptionalbindTemplate?: unknownOptional Readonlychildren?: unknownCollection of the child views inside of the button #element.
Optional Readonlyclass?: unknownOptionalcreateCollection?: unknownOptionaldecorate?: unknownOptionaldelegate?: unknownOptionalderegisterChild?: unknownOptionaldestroy?: unknownOptional Readonlyelement?: unknownAn HTML element of the view. null until #render 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' );
OptionalextendTemplate?: unknownOptionalfire?: unknownOptionalfocus?: unknownOptional ReadonlyhasCheckSpace?: unknownIndicates whether the button view has reserved space for a check holder.
Optional Readonlyicon?: unknownOptional ReadonlyiconView?: unknownThe icon view of the button. Will be added to #children when the #icon icon attribute is defined.
Optional ReadonlyisEnabled?: unknownOptional ReadonlyisOn?: unknownOptional ReadonlyisRendered?: unknownSet true when the view has already been module:ui/view~View#render rendered.
Optional ReadonlyisToggleable?: unknownOptional ReadonlyisVisible?: unknownOptional Readonlykeystroke?: unknownOptional ReadonlykeystrokeView?: unknownA view displaying the keystroke of the button next to the #labelView label.
Added to #children when the #withKeystroke withKeystroke attribute
is defined.
Optional Readonlylabel?: unknownOptional ReadonlylabelStyle?: unknownOptional ReadonlylabelView?: unknownLabel of the button view. Its text is configurable using the #label label attribute.
If not configured otherwise in the constructor(), by default the label is an instance
of module:ui/button/buttonlabelview~ButtonLabelView.
OptionallistenTo?: unknownOptional Readonlylocale?: unknownA set of tools to localize the user interface.
Also see module:core/editor/editor~Editor#locale.
Optionaloff?: unknownOptionalon?: unknownOptionalonce?: unknownOptionalregisterChild?: unknownOptionalrender?: unknownOptional Readonlyrole?: unknownOptionalset?: unknownOptionalsetTemplate?: unknownOptionalstopDelegating?: unknownOptionalstopListening?: unknownOptional Readonlyt?: unknownShorthand for module:utils/locale~Locale#t.
Note: If #locale instance hasn't been passed to the view this method may not be available.
Optional Readonlytabindex?: unknownOptional Readonlytemplate?: unknownTemplate of this view. It provides the #element representing the view in DOM, which is #render rendered.
Optional Readonlytooltip?: unknownOptional ReadonlytooltipPosition?: unknownOptional Readonlytype?: unknownOptionalunbind?: unknownOptional ReadonlyviewUid?: unknownOptional ReadonlywithKeystroke?: unknownOptional ReadonlywithText?: unknownSets the #template of the view with with given definition.
A shorthand for:
view.setTemplate( definition );
Definition of view's template.
Stops delegating events. It can be used at different levels:
Optionalevent: stringThe name of the event to stop delegating. If omitted, stops it all delegations.
Optionalemitter: Emitter(requires event) The object to stop delegating a particular event to.
If omitted, stops delegation of event to all emitters.
Stops listening for events. It can be used at different levels: It is backwards compatible with module:utils/emittermixin~Emitter#listenTo.
Optionalemitter: Node | EventTarget | Emitter | WindowThe object to stop listening to. If omitted, stops it for all objects.
Optionalevent: string(Requires the emitter) The name of the event to stop listening to. If omitted, stops it
for all events from emitter.
Optionalcallback: Function(Requires the event) The function to be removed from the call list for the given
event.
Stops listening for events. It can be used at different levels:
Optionalemitter: EmitterThe object to stop listening to. If omitted, stops it for all objects.
Optionalevent: string(Requires the emitter) The name of the event to stop listening to. If omitted, stops it
for all events from emitter.
Optionalcallback: Function(Requires the event) The function to be removed from the call list for the given
event.
Removes the binding created with #bind.
// Removes the binding for the 'a' property.
A.unbind( 'a' );
// Removes bindings for all properties.
A.unbind();
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Button that is used as dropdown list item entry.