List
pentaho.type.List
The base class of plural values.
A list is an ordered set of elements
of a common, base type
.
AMD Module
require(["pentaho/type/list"], function(List) { /* code goes here */ });
See also: pentaho.type.Element , pentaho.type.spec.IList , pentaho.type.spec.IListProto , pentaho.type.spec.IListTypeProto
Extends
Constructor
Name | Description |
---|---|
new List(spec, keyArgs) | Creates a list instance. |
Classes
Name | Summary |
---|---|
Type | The base type class of plural value types. |
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. |
$isBoundary : | Gets a value that indicates if this list is a boundary list. |
$isReadOnly : | Gets a value that indicates if this list is read-only. |
$isValid : | Determines if this value is a valid instance of its type. |
$key : | Gets the key of the list value. |
$references : | Gets the references to this container, or |
$type : | Gets the type of this instance. |
$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. |
configure | Configures a list instance with a given configuration. |
count : | Gets the number of elements in the list. |
Methods
Name | Description |
---|---|
extend(name, instSpec, classSpec, keyArgs) : Class.< Static | Creates a subtype of this one. |
_configure(config) Protected | Configures this value with a given non-nully configuration. |
_createChangeset(transaction) : pentaho.type.changes.Changeset 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(event, type, phase, keyArgs) : object Protected | Emits an event given an arbitrary payload object, its type and phase. Returns the event payload object, unless the event is canceled. |
_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 phase. |
_hasObservers(type) : boolean Protected | Determines if there are any registrations for a given event type, for at least one of its phases. |
_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) : pentaho.lang.UserError | undefined Protected | Called before a changeset is committed. |
add(fragment) | Adds and/or updates one or more elements to the end of the list. |
assertValid() | Ensures that the value is valid, and throws the first validation error if it is not. |
at(index) : pentaho.type.Element | Gets the element at a specified index, or |
clear() | Removes all elements from the list. |
clone() : pentaho.type.Value Abstract | Creates a shallow clone of this value. |
each(fun, ctx) | Calls a function for each element of the list. |
equals(other) : boolean | Determines if a given value, of the same type, represents the same entity. |
extend(source, keyArgs) : Object | Extend an object with the properties of another. |
get(key) : pentaho.type.Element | Gets the element having a specified key value, if any, or |
has(key) : boolean | Gets a value that indicates if an element with a given key is present in the list. |
includes(elem) : boolean | Gets a value that indicates if a given element is present in the list. |
indexOf(elem) : number | Gets the index of a given element in the list. |
insert(fragment, index) | Inserts and/or updates one or more elements, starting at the given index. |
move(elemSpec, indexNew) | Moves an element to a new position. |
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). |
remove(fragment) | Removes one or more elements from the list. |
removeAt(start, count) | Removes one or more elements from the list, given the start index and the number of elements to remove. |
set(fragment, keyArgs) | Adds, removes, moves and/or updates elements to the element list. |
sort(comparer) | Sorts the elements of the list using the given comparer function. |
toArray(map, ctx) : Array.< | Creates an array with the elements of the list or values derived from each element. |
toJSON() : UJsonValue | Creates a top-level JSON specification that describes this instance. |
toSpec(keyArgs) : pentaho.type.spec.UInstance | Creates a specification that describes this value. |
toSpecInContext(keyArgs) : any | Creates a specification that describes this instance. |
validate() : Array.< | Determines if this value is a valid instance of its type. |
Constructor Details
new List(spec, keyArgs) | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a list instance. When a derived class overrides the constructor and creates additional instance properties, the Source: javascript/web/pentaho/type/list.js, line 74
See also: pentaho.type.Element , pentaho.type.spec.IList , pentaho.type.spec.IListProto , pentaho.type.spec.IListTypeProto |
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 203 Inherited From: pentaho.type.mixins.Container#$changeset |
$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 213 Inherited From: pentaho.type.mixins.Container#$hasChanges |
$isBoundary: |
---|
Gets a value that indicates if this list is a boundary list. A boundary list isolates the list holder from the list's elements. The validity of a boundary list is not affected by the validity of its elements. Changes within the elements of boundary list do not bubble to it. |
$isReadOnly: |
---|
Gets a value that indicates if this list is read-only. |
$isValid: |
---|
Determines if this value is a valid instance of its type. This attribute calls Source: javascript/web/pentaho/type/value.js, line 123 Inherited From: pentaho.type.Value#$isValid |
$key: |
---|
Gets the key of the list value. The key of a value identifies it among values of the same concrete type. If two values have the same concrete type and their keys are equal, then it must also be the case that The default list implementation, returns the value of the list instance's Source: javascript/web/pentaho/type/list.js, line 271 Overrides: pentaho.type.Value#$key |
$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 145 Inherited From: pentaho.type.mixins.Container#$references |
$type: |
---|
Gets the type of this instance. Source: javascript/web/pentaho/type/value.js, line 246 Overrides: pentaho.type.Value#$type |
$uid: |
---|
Gets the unique identifier of the instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 129 Inherited From: pentaho.type.mixins.Container#$uid |
$version: |
---|
Gets the current version of the instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 177 Inherited From: pentaho.type.mixins.Container#$version |
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 |
configure: |
---|
Configures a list instance with a given configuration. When When Source: javascript/web/pentaho/type/list.js, line 189 Overrides: pentaho.type.Value#configure |
count: |
---|
Gets the number of elements in the list. |
Methods Details
extend(name, instSpec, classSpec, keyArgs) : Class.< Static | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a subtype of this one. For more information on class extension, in general, see Source: javascript/web/pentaho/type/list.js, line 765
See also: pentaho.type.Value.extend |
_configure(config) Protected | ||||||
---|---|---|---|---|---|---|
Configures this value with a given non-nully configuration. The default implementation does nothing. Source: javascript/web/pentaho/type/value.js, line 178 Overrides: pentaho.type.Value#_configure
|
_createChangeset(transaction) : pentaho.type.changes.Changeset Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a changeset with this container as owner and returns it. Source: javascript/web/pentaho/type/mixins/Container.js, line 238 Overrides: pentaho.type.mixins.Container#_createChangeset
|
_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 261 Inherited From: pentaho.lang.EventSource#_emit
See also: pentaho.lang.EventSource#_emitSafe , pentaho.lang.EventSource#_emitGeneric |
_emitGeneric(event, type, phase, keyArgs) : object 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 313 Inherited From: pentaho.lang.EventSource#_emitGeneric
|
_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 283 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 phase. This method can be used to avoid creating expensive event objects for event type and phase pairs that don't have registrations. Source: javascript/web/pentaho/lang/EventSource.js, line 189 Inherited From: pentaho.lang.EventSource#_hasListeners
Example if(this._hasListeners("select", "will")) { var event = new Event("select", this); if(this._emit(event)) { // Select Will phase } } |
_hasObservers(type) : boolean Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if there are any registrations for a given event type, for at least one of its phases. This method can be used to avoid creating expensive event objects for event types that currently have no registrations. Source: javascript/web/pentaho/lang/EventSource.js, line 232 Inherited From: pentaho.lang.EventSource#_hasObservers
Example if(this._hasObservers("select")) { var event = new Event("select"); if(this._emitGeneric(event, "select", "will")) { // Select Will this._emitGeneric(event, "select", "did"); } } |
_initClone(clone) Protected | ||||||
---|---|---|---|---|---|---|
Initializes a shallow clone of this container. The default implementation calls Source: javascript/web/pentaho/type/mixins/Container.js, line 119 Overrides: pentaho.type.mixins.Container#_initClone
|
_initContainer() Protected |
---|
Initializes a container instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 53 Inherited From: pentaho.type.mixins.Container#_initContainer |
_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 290 Inherited From: pentaho.type.mixins.Container#_onChangeDid
|
_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 311 Inherited From: pentaho.type.mixins.Container#_onChangeRejected
|
_onChangeWill(changeset) : pentaho.lang.UserError | undefined 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 269 Inherited From: pentaho.type.mixins.Container#_onChangeWill
|
add(fragment) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Adds and/or updates one or more elements to the end of the list. The element or elements specified in argument Source: javascript/web/pentaho/type/list.js, line 387
|
assertValid() | ||||
---|---|---|---|---|
Ensures that the value is valid, and throws the first validation error if it is not. This method calls the Source: javascript/web/pentaho/type/value.js, line 152 Inherited From: pentaho.type.Value#assertValid
|
at(index) : pentaho.type.Element | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets the element at a specified index, or Source: javascript/web/pentaho/type/list.js, line 291
|
clear() | ||||
---|---|---|---|---|
Removes all elements from the list. Source: javascript/web/pentaho/type/list.js, line 490
|
clone() : pentaho.type.Value Abstract | ||||
---|---|---|---|---|
Creates a shallow clone of this value. Source: javascript/web/pentaho/type/value.js, line 86 Overrides: pentaho.type.mixins.Container#clone
|
each(fun, ctx) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Calls a function for each element of the list. Source: javascript/web/pentaho/type/list.js, line 520
|
equals(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a given value, of the same type, represents the same entity. The default implementation delegates the operation to the Source: javascript/web/pentaho/type/value.js, line 107 Inherited From: pentaho.type.Value#equals
See also: pentaho.type.Value#$key , pentaho.type.Value.Type#areEqual |
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
|
get(key) : pentaho.type.Element | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets the element having a specified key value, if any, or Source: javascript/web/pentaho/type/list.js, line 338
|
has(key) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if an element with a given key is present in the list. Source: javascript/web/pentaho/type/list.js, line 303
|
includes(elem) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given element is present in the list. Source: javascript/web/pentaho/type/list.js, line 316
|
indexOf(elem) : number | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets the index of a given element in the list. Source: javascript/web/pentaho/type/list.js, line 327
|
insert(fragment, index) | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Inserts and/or updates one or more elements, starting at the given index. If When the index is greater than or equal to the length of the list, the element or elements are appended to the list. Source: javascript/web/pentaho/type/list.js, line 405
|
move(elemSpec, indexNew) | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Moves an element to a new position. Source: javascript/web/pentaho/type/list.js, line 436
|
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
remove(fragment) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Removes one or more elements from the list. Specified elements that are not present in the list are ignored. Source: javascript/web/pentaho/type/list.js, line 419
|
removeAt(start, count) | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Removes one or more elements from the list, given the start index and the number of elements to remove. If Source: javascript/web/pentaho/type/list.js, line 460
|
set(fragment, keyArgs) | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Adds, removes, moves and/or updates elements to the element list. The element or elements specified in argument Source: javascript/web/pentaho/type/list.js, line 366
|
sort(comparer) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Sorts the elements of the list using the given comparer function. Source: javascript/web/pentaho/type/list.js, line 476
|
toArray(map, ctx) : Array.< | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates an array with the elements of the list or values derived from each element. Source: javascript/web/pentaho/type/list.js, line 507
|
toJSON() : UJsonValue | ||||
---|---|---|---|---|
Creates a top-level JSON specification that describes this instance. Attributes which do not have a JSON-compatible specification are omitted. Specifically, for inline types, attributes with a function value are not supported. This method simply calls Source: javascript/web/pentaho/type/instance.js, line 210 Inherited From: pentaho.type.Instance#toJSON
See also: pentaho.type.Instance#toSpec |
toSpec(keyArgs) : pentaho.type.spec.UInstance | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this value. If an Source: javascript/web/pentaho/type/value.js, line 184 Inherited From: pentaho.type.Value#toSpec |
Name | Default Value | Summary | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
keyArgs : Object Optional | The keyword arguments object. Passed to every value and type serialized within this scope. Please see the documentation of value subclasses for information on additional, supported keyword arguments.
|
Name | Description |
---|---|
pentaho.type.spec.UInstance | A specification of this value. |
toSpecInContext(keyArgs) : any | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this instance. Source: javascript/web/pentaho/type/instance.js, line 190 Overrides: pentaho.type.Value#toSpecInContext
See also: pentaho.type.Instance#toSpec |
validate() : Array.< | ||||
---|---|---|---|---|
Determines if this value is a valid instance of its type. The default implementation delegates to Source: javascript/web/pentaho/type/value.js, line 137 Inherited From: pentaho.type.Value#validate
See also: pentaho.type.Value#$isValid |