Container
pentaho.type.mixins. Container
A mixin class that contains functionality shared by the instance container classes: Complex
and List
.
Extends
Constructor
Name | Description |
---|---|
new Container() | This class was not designed to be constructed directly. It was designed to be used as a mixin. |
Members
Name | Description |
---|---|
$changeset : | Gets the changeset of this instance in the ambient transaction, if any, or |
$hasChanges : | Gets a value that indicates if this instance has any changes in the ambient transaction. |
$references : | Gets the references to this container, or |
$uid : | Gets the unique identifier of the instance. |
$version : | Gets the current version of the instance. |
base : Protected | If a method has been overridden, then the base method provides access to the overridden method. |
Methods
Name | Description |
---|---|
_createChangeset(transaction) : pentaho.type.changes.Changeset Abstract Protected | Creates a changeset with this container as owner and returns it. |
_emit(event) : pentaho.lang.Event Protected | Emits an unstructured event and returns it, unless it was canceled. |
_emitGeneric(source, eventArgs, type, phase, keyArgs) : boolean Protected | Emits an event given an arbitrary payload object, its type and phase. Returns the event payload object, unless the event is canceled. |
_emitGenericAllAsync(source, eventArgs, type, phase, keyArgs) : Promise.< Protected | Emits an event asynchronously, given an arbitrary payload object, its type and phase, and succeeding if every listener succeeds. |
_emitSafe(event) : pentaho.lang.Event Protected | Variation of the |
_hasListeners(type, phase) : boolean Protected | Determines if there are any registrations for a given event type and, optionally, phase. |
_initClone(clone) Protected | Initializes a shallow clone of this container. |
_initContainer() Protected | Initializes a container instance. |
_onChangeDid(changeset) Protected | Called after a changeset has been committed. |
_onChangeRejected(changeset, reason) Protected | Called after a changeset has been rejected. |
_onChangeWill(changeset, keyArgs) : pentaho.lang.UserError Protected | Called before a changeset is committed. |
clone() : pentaho.type.mixins.Container | Creates a shallow clone of this container. |
extend(source, keyArgs) : Object | Extend an object with the properties of another. |
off(typeOrHandle, observer) | Removes one registration given its handle, or all registrations of a given event type (or types) and observer (or listener function). |
on(type, observer, keyArgs) : pentaho.lang.IEventRegistrationHandle | Registers an observer (or listener function) for an event(s) of a given type(s). |
Constructor Details
new Container() |
---|
This class was not designed to be constructed directly. It was designed to be used as a mixin. Source: javascript/web/pentaho/type/mixins/Container.js, line 37 |
Members Details
$changeset: |
---|
Gets the changeset of this instance in the ambient transaction, if any, or Source: javascript/web/pentaho/type/mixins/Container.js, line 194 |
$hasChanges: |
---|
Gets a value that indicates if this instance has any changes in the ambient transaction. Source: javascript/web/pentaho/type/mixins/Container.js, line 204 |
$references: |
---|
Gets the references to this container, or Note that the returned array may be empty. Do NOT change the returned array or its elements in any way. Source: javascript/web/pentaho/type/mixins/Container.js, line 137 |
$uid: |
---|
Gets the unique identifier of the instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 56 |
$version: |
---|
Gets the current version of the instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 168 |
base: Protected |
---|
If a method has been overridden, then the base method provides access to the overridden method. Can also be called from within a constructor function. Source: javascript/web/pentaho/lang/Base.js, line 299 Inherited From: pentaho.lang.Base#base |
Methods Details
_createChangeset(transaction) : pentaho.type.changes.Changeset Abstract Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a changeset with this container as owner and returns it. Source: javascript/web/pentaho/type/mixins/Container.js, line 229
|
_emit(event) : pentaho.lang.Event Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Emits an unstructured event and returns it, unless it was canceled. When this method is called, the listeners of existing registrations are notified synchronously, by priority order and then registration order, until either the event is canceled or all of the listeners have been notified. It is safe to register or unregister to/from an event type while it is being emitted. However, changes are only taken into account in subsequent emissions. If a listener function throws an error, the event processing is interrupted. No more registrations are processed and the error is passed to the caller. Source: javascript/web/pentaho/lang/EventSource.js, line 269 Inherited From: pentaho.lang.EventSource#_emit
See also: pentaho.lang.EventSource#_emitSafe , pentaho.lang.EventSource#_emitGeneric |
_emitGeneric(source, eventArgs, type, phase, keyArgs) : boolean Protected | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Emits an event given an arbitrary payload object, its type and phase. Returns the event payload object, unless the event is canceled. Source: javascript/web/pentaho/lang/EventSource.js, line 325 Inherited From: pentaho.lang.EventSource#_emitGeneric
|
_emitGenericAllAsync(source, eventArgs, type, phase, keyArgs) : Promise.< Protected | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Emits an event asynchronously, given an arbitrary payload object, its type and phase, and succeeding if every listener succeeds. Listeners are called in parallel. Returns a promise that is fulfilled or rejected with the event payload object. If any listener throws or rejects, the returned promise is rejected as well. Source: javascript/web/pentaho/lang/EventSource.js, line 454 Inherited From: pentaho.lang.EventSource#_emitGenericAllAsync
|
_emitSafe(event) : pentaho.lang.Event Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Variation of the If an event listener throws an error, the following event listeners are still processed. Source: javascript/web/pentaho/lang/EventSource.js, line 291 Inherited From: pentaho.lang.EventSource#_emitSafe
See also: pentaho.lang.EventSource#_emit , pentaho.lang.EventSource#_emitGeneric |
_hasListeners(type, phase) : boolean Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Determines if there are any registrations for a given event type and, optionally, phase. This method can be used to avoid creating expensive event objects for an event type and, optionally, phase, that don't have registrations. Source: javascript/web/pentaho/lang/EventSource.js, line 218 Inherited From: pentaho.lang.EventSource#_hasListeners
Examples if(this._hasListeners("click")) { var event = new Event("click", this, true); if(this._emit(event)) { // ... } } if(this._hasListeners("select")) { var event = new Event("select"); if(this._emitGeneric(this, [event], "select", "will")) { // Select ... this._emitGeneric(this, [event], "select", "finally"); } } |
_initClone(clone) Protected | ||||||
---|---|---|---|---|---|---|
Initializes a shallow clone of this container. The default implementation calls Source: javascript/web/pentaho/type/mixins/Container.js, line 121
|
_initContainer() Protected |
---|
Initializes a container instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 55 |
_onChangeDid(changeset) Protected | ||||||
---|---|---|---|---|---|---|
Called after a changeset has been committed. The default implementation emits the "did:change" event for the given changeset, if there are any listeners. When overriding, be sure to call the base implementation. Source: javascript/web/pentaho/type/mixins/Container.js, line 300
|
_onChangeRejected(changeset, reason) Protected | |||||||||
---|---|---|---|---|---|---|---|---|---|
Called after a changeset has been rejected. The default implementation emits the "rejected:change" event for the given changeset, if there are any listeners. When overriding, be sure to call the base implementation. Source: javascript/web/pentaho/type/mixins/Container.js, line 321
|
_onChangeWill(changeset, keyArgs) : pentaho.lang.UserError Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Called before a changeset is committed. The default implementation emits the "will:change" event for the given changeset, if there are any listeners. When overriding, be sure to call the base implementation. Source: javascript/web/pentaho/type/mixins/Container.js, line 262
|
clone() : pentaho.type.mixins.Container | ||||
---|---|---|---|---|
Creates a shallow clone of this container. All property values or elements are shared with the clone. Source: javascript/web/pentaho/type/mixins/Container.js, line 106
|
extend(source, keyArgs) : Object | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Extend an object with the properties of another. Methods that are overridden are accessible through This object is extended, but its class doesn't change. Source: javascript/web/pentaho/lang/Base.js, line 1037 Inherited From: pentaho.lang.Base#extend
|
off(typeOrHandle, observer) | ||
---|---|---|
Removes one registration given its handle, or all registrations of a given event type (or types) and observer (or listener function). To remove an event registration, it is sufficient to call the It is safe to unregister from an event type while it is being emitted. However, any registrations removed during the current emission will still execute. Specifying an event registration handle that has already been disposed of has no effect. Specifying an event type and observer (or listener function) that have no registrations has no effect. Source: doc-js/pentaho/lang/IEventSource.jsdoc, line 131 Inherited From: pentaho.lang.EventSource#off |
Name | Default Value | Summary |
---|---|---|
typeOrHandle : nonEmptyString | Array.< | pentaho.lang.IEventRegistrationHandle | The type or types of events, or an event registration handle to dispose of. When a string, it can be a comma-separated list of event types. | |
observer : pentaho.lang.IEventObserver | pentaho.lang.EventListener | pentaho.lang.EventListenerAsync | The event observer (or listener function). Required when |
See also: pentaho.lang.IEventSource#on
on(type, observer, keyArgs) : pentaho.lang.IEventRegistrationHandle | ||||||||
---|---|---|---|---|---|---|---|---|
Registers an observer (or listener function) for an event(s) of a given type(s). Optionally, a listening priority may be specified to adjust the order by which an observer is notified, relative to other listeners. Note that if an observer is registered more than once to the same event type, a new registration is created each time and its listeners will be called once per registration. It is safe to register for an event type while it is being emitted. However, new registrations are only taken into account in subsequent emissions. When This method is compatible with the dojo/on API. Source: doc-js/pentaho/lang/IEventSource.jsdoc, line 90 Inherited From: pentaho.lang.EventSource#on |
Name | Default Value | Summary | ||||||
---|---|---|---|---|---|---|---|---|
type : nonEmptyString | Array.< | The type or types of events. When a string, it can be a comma-separated list of event types. | |||||||
observer : pentaho.lang.IEventObserver | pentaho.lang.EventListener | pentaho.lang.EventListenerAsync | The event observer (or listener function). | |||||||
keyArgs : object Optional | Keyword arguments.
|
Name | Description |
---|---|
pentaho.lang.IEventRegistrationHandle | An event registration handle that can be used for later removal. |
See also: pentaho.lang.IEventSource#off