Class: SC.Enumerable

This mixin defines the common interface implemented by enumerable objects in SproutCore. Most of these methods follow the standard Array iteration API defined up to JavaScript 1.8 (excluding language-specific features that cannot be emulated in older versions of JavaScript).

This mixin is applied automatically to the Array class on page load, so you can use any of these methods on simple arrays. If Array already implements one of these methods, the mixin will not override them.

Writing Your Own Enumerable

To make your own custom class enumerable, you need two items:

  1. You must have a length property. This property should change whenever the number of items in your enumerable object changes. If you using this with an SC.Object subclass, you should be sure to change the length property using set().

  2. You must implement nextObject(). See documentation.

Once you have these two methods implemented, apply the SC.Enumerable mixin to your class and you will be able to enumerate the contents of your object like any other collection.

Using SproutCore Enumeration with Other Libraries

Many other libraries provide some kind of iterator or enumeration like facility. This is often where the most common API conflicts occur. SproutCore's API is designed to be as friendly as possible with other libraries by implementing only methods that mostly correspond to the JavaScript 1.8 API.

Defined in: enumerable.js

Since:
SproutCore 1.0

Field Summary

Instance Methods

Field Detail

isEnumerable Boolean
Walk like a duck.

Instance Method Detail

enumerator()

Returns a new enumerator for this object. See SC.Enumerator for documentation on how to use this object. Enumeration is an alternative to using one of the other iterators described here.

Returns:
SC.Enumerator
an enumerator for the receiver
every(callback, target)

Returns YES if the passed function returns YES for every item in the enumeration. This corresponds with the every() method in JavaScript 1.6.

The callback method you provide should have the following signature (all parameters are optional):

function (item, index, enumerable);
  • item is the current item in the iteration.
  • index is the current index in the iteration
  • enumerable is the enumerable object itself.

It should return the YES or NO.

Note that in addition to a callback, you can also pass an optional target object that will be set as "this" on the context. This is a good way to give your iterator function access to the current object.

Example Usage:

if (people.every(isEngineer)) { Paychecks.addBigBonus(); }
Parameters:
callback Function
the callback to execute
target Object
the target object to use
Returns:
Boolean
everyProperty(key, value)

Returns YES if the passed property resolves to true for all items in the enumerable. This method is often simpler/faster than using a callback.

Parameters:
key String
the property to test
value String
optional value to test against.
Returns:
Array
filtered array
filter(callback, target)

Returns an array with all of the items in the enumeration that the passed function returns YES for. This method corresponds to filter() defined in JavaScript 1.6.

The callback method you provide should have the following signature (all parameters are optional):

function (item, index, enumerable);
  • item is the current item in the iteration.
  • index is the current index in the iteration
  • enumerable is the enumerable object itself.

It should return the YES to include the item in the results, NO otherwise.

Note that in addition to a callback, you can also pass an optional target object that will be set as "this" on the context. This is a good way to give your iterator function access to the current object.

Parameters:
callback Function
the callback to execute
target Object
the target object to use
Returns:
Array
A filtered array.
filterProperty(key, value)

Returns an array with just the items with the matched property. You can pass an optional second argument with the target value. Otherwise this will match any property that evaluates to true.

Note: null, undefined, false and the empty string all evaulate to false.

Parameters:
key String
the property to test
value String
optional value to test against.
Returns:
Array
filtered array
find(callback, target)

Returns the first item in the array for which the callback returns YES. This method works similar to the filter() method defined in JavaScript 1.6 except that it will stop working on the array once a match is found.

The callback method you provide should have the following signature (all parameters are optional):

function (item, index, enumerable);
  • item is the current item in the iteration.
  • index is the current index in the iteration
  • enumerable is the enumerable object itself.

It should return the YES to include the item in the results, NO otherwise.

Note that in addition to a callback, you can also pass an optional target object that will be set as "this" on the context. This is a good way to give your iterator function access to the current object.

Parameters:
callback Function
the callback to execute
target Object
the target object to use
Returns:
Object
Found item or null.
findProperty(key, value)

Returns an the first item with a property matching the passed value. You can pass an optional second argument with the target value. Otherwise this will match any property that evaluates to true.

This method works much like the more generic find() method.

Parameters:
key String
the property to test
value String
optional value to test against.
Returns:
Object
found item or null
firstObject()

Helper method returns the first object from a collection. This is usually used by bindings and other parts of the framework to extract a single object if the enumerable contains only one item.

If you override this method, you should implement it so that it will always return the same value each time it is called. If your enumerable contains only one object, this method should always return that object. If your enumerable is empty, this method should return undefined.

This property is observable if the enumerable supports it. Examples of enumerables where firstObject is observable include SC.Array, SC.ManyArray and SC.SparseArray. To implement a custom enumerable where firstObject is observable, see #enumerableContentDidChange.

Returns:
Object
the object or undefined
See:
#enumerableContentDidChange
forEach(callback, target)

Iterates through the enumerable, calling the passed function on each item. This method corresponds to the forEach() method defined in JavaScript 1.6.

The callback method you provide should have the following signature (all parameters are optional):

function (item, index, enumerable);
  • item is the current item in the iteration.
  • index is the current index in the iteration
  • enumerable is the enumerable object itself.

Note that in addition to a callback, you can also pass an optional target object that will be set as "this" on the context. This is a good way to give your iterator function access to the current object.

Parameters:
callback Function
the callback to execute
target Object
the target object to use
Returns:
Object
this
getEach(key)

Retrieves the named value on each member object. This is more efficient than using one of the wrapper methods defined here. Objects that implement SC.Observable will use the get() method, otherwise the property will be accessed directly.

Parameters:
key String
the key to retrieve
Returns:
Array
extracted values
groupBy(key)

Converts an enumerable into a matrix, with inner arrays grouped based on a particular property of the elements of the enumerable.

Parameters:
key String
the property to test
Returns:
Array
matrix of arrays
invoke(methodName, args)

Invokes the named method on every object in the receiver that implements it. This method corresponds to the implementation in Prototype 1.6.

Parameters:
methodName String
the name of the method
args Object...
optional arguments to pass as well.
Returns:
Array
return values from calling invoke.
invokeWhile(targetValue, methodName, args)

Invokes the passed method and optional arguments on the receiver elements as long as the methods return value matches the target value. This is a useful way to attempt to apply changes to a collection of objects unless or until one fails.

Parameters:
targetValue Object
the target return value
methodName String
the name of the method
args Object...
optional arguments to pass as well.
Returns:
Array
return values from calling invoke.
lastObject()

Helper method returns the last object from a collection.

This property is observable if the enumerable supports it. Examples of enumerables where lastObject is observable include SC.Array, SC.ManyArray and SC.SparseArray. To implement a custom enumerable where lastObject is observable, see #enumerableContentDidChange.

Returns:
Object
the object or undefined
See:
#enumerableContentDidChange
map(callback, target)

Maps all of the items in the enumeration to another value, returning a new array. This method corresponds to map() defined in JavaScript 1.6.

The callback method you provide should have the following signature (all parameters are optional):

function (item, index, enumerable);
  • item is the current item in the iteration.
  • index is the current index in the iteration
  • enumerable is the enumerable object itself.

It should return the mapped value.

Note that in addition to a callback, you can also pass an optional target object that will be set as "this" on the context. This is a good way to give your iterator function access to the current object.

Parameters:
callback Function
the callback to execute
target Object
the target object to use
Returns:
Array
The mapped array.
mapProperty(key)

Similar to map, this specialized function returns the value of the named property on all items in the enumeration.

Parameters:
key String
name of the property
Returns:
Array
The mapped array.
nextObject(index, previousObject, context)

Implement this method to make your class enumerable.

This method will be called repeatedly during enumeration. The index value will always begin with 0 and increment monotonically. You don't have to rely on the index value to determine what object to return, but you should always check the value and start from the beginning when you see the requested index is 0.

The previousObject is the object that was returned from the last call to nextObject for the current iteration. This is a useful way to manage iteration if you are tracing a linked list, for example.

Finally the context parameter will always contain a hash you can use as a "scratchpad" to maintain any other state you need in order to iterate properly. The context object is reused and is not reset between iterations so make sure you setup the context with a fresh state whenever the index parameter is 0.

Generally iterators will continue to call nextObject until the index reaches the your current length-1. If you run out of data before this time for some reason, you should simply return undefined.

The default implementation of this method simply looks up the index. This works great on any Array-like objects.

Parameters:
index Number
the current index of the iteration
previousObject Object
the value returned by the last call to nextObject.
context Object
a context object you can use to maintain state.
Returns:
Object
the next object in the iteration or undefined
reduce(callback, initialValue, reducerProperty)

This will combine the values of the enumerator into a single value. It is a useful way to collect a summary value from an enumeration. This corresponds to the reduce() method defined in JavaScript 1.8.

The callback method you provide should have the following signature (all parameters are optional):

function (previousValue, item, index, enumerable);
  • previousValue is the value returned by the last call to the iterator.
  • item is the current item in the iteration.
  • index is the current index in the iteration
  • enumerable is the enumerable object itself.

Return the new cumulative value.

In addition to the callback you can also pass an initialValue. An error will be raised if you do not pass an initial value and the enumerator is empty.

Note that unlike the other methods, this method does not allow you to pass a target object to set as this for the callback. It's part of the spec. Sorry.

Parameters:
callback Function
the callback to execute
initialValue Object
initial value for the reduce
reducerProperty String
internal use only. May not be available.
Returns:
Object
The reduced value.
setEach(key, value)

Sets the value on the named property for each member. This is more efficient than using other methods defined on this helper. If the object implements SC.Observable, the value will be changed to set(), otherwise it will be set directly. null objects are skipped.

Parameters:
key String
the key to set
value Object
the object to set
Returns:
Object
receiver
some(callback, target)

Returns YES if the passed function returns true for any item in the enumeration. This corresponds with the every() method in JavaScript 1.6.

The callback method you provide should have the following signature (all parameters are optional):

function (item, index, enumerable);
  • item is the current item in the iteration.
  • index is the current index in the iteration
  • enumerable is the enumerable object itself.

It should return the YES to include the item in the results, NO otherwise.

Note that in addition to a callback, you can also pass an optional target object that will be set as "this" on the context. This is a good way to give your iterator function access to the current object.

Usage Example:

if (people.some(isManager)) { Paychecks.addBiggerBonus(); }
Parameters:
callback Function
the callback to execute
target Object
the target object to use
Returns:
Boolean
YES
someProperty(key, value)

Returns YES if the passed property resolves to true for any item in the enumerable. This method is often simpler/faster than using a callback.

Parameters:
key String
the property to test
value String
optional value to test against.
Returns:
Boolean
YES
sortProperty(key)

Returns an array sorted by the value of the passed key parameters. null objects will be sorted first. You can pass either an array of keys or multiple parameters which will act as key names

Parameters:
key String
one or more key names
Returns:
Array
toArray()

Simply converts the enumerable into a genuine array. The order, of course, is not gauranteed. Corresponds to the method implemented by Prototype.

Returns:
Array
the enumerable as an array.
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Apr 08 2015 10:02:20 GMT-0600 (CST)