Children
Type class
A version of List to hold children of the Container.
More info: Containers
Sources
This information about Children is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.
Inheritance
Children extends List.
Children is not extended by any other symbol.
Properties
3 inherited items
eventsType
EventDispatcherDefaultnew EventDispatcher()Inherited fromListlengthType
numberInherited fromListNumber of items in list.
valuesAn array of values in the list.
Don't change this array directly: use methods like
push()andremoveIndex(), which dispatch the list's events.
Methods
constructor(container:Container)Returns
Childrendispose()Returns
voidDisposes the list and all children in it.
isDisposed()Returns
booleanReturns
trueif the list is disposed.
21 inherited items
[Symbol.iterator]()Returns
IteratorInherited fromListReturns an ES6 iterator for the list.
clear()Returns
voidInherited fromListRemoves all items from the list.
contains(value:T)Returns
booleanInherited fromListChecks if list contains specific item reference.
copyFrom(source:this)Returns
voidInherited fromListAdds all items of another list to the end of this one.
each(f: (value:T, index:number) =>void)Returns
voidInherited fromListCalls
ffor each item in the list, with the item and its index.eachReverse(f: (value:T, index:number) =>void)Returns
voidInherited fromListCalls
ffor each item in the list, from last to first, with the item and its index.getIndex(index:number)Returns
T|undefinedInherited fromListReturns an item at specified index.
hasIndex(index:number)Returns
booleanInherited fromListChecks if there's a value at specific index.
indexOf(value:T)Returns
numberInherited fromListSearches the list for specific item and returns its index.
insertIndex(index:number,
value:K)Returns
KInherited fromListInserts an item at
index, moving the items from there on one place further.moveValue(value:K,
toIndex?:undefined|number)Returns
KInherited fromListMoves an item to
toIndex, or to the end of the list iftoIndexis not set. An item that is not in the list yet is added.pop()Returns
OptionalInherited fromListReturns the last item from the list, and removes it.
push(value:K)Returns
KInherited fromListAdds an item to the end of the list.
pushAll(values:Array)Returns
voidInherited fromListAdds multiple items to the end of the list.
removeIndex(index:number)Returns
TInherited fromListRemoves a value at specific index.
removeValue(value:T)Returns
voidInherited fromListRemoves all copies of an item from the list.
setAll(newArray:Array)Returns
voidInherited fromListReplaces all items in the list with
newArray.setIndex(index:number,
value:T)Returns
TInherited fromListReplaces the value at
index, which must already exist.shift()Returns
OptionalInherited fromListReturns the first item from the list, and removes it.
swap(a:number,
b:number)Returns
voidInherited fromListSwaps two items in the list.
unshift(value:K)Returns
KInherited fromListAdds an item as a first item in the list.
Events
Add event handlers to Children object using its events.on() method. Read about adding event handlers.
7 inherited items
clearParam { type:
"clear", target:Children, oldValues:Array}Inherited fromListAll items were removed, by
clear()orsetAll().insertIndexParam { type:
"insertIndex", target:Children, index:number, newValue:A}Inherited fromListAn item was inserted at
index.moveIndexParam { type:
"moveIndex", target:Children, newIndex:number, oldIndex:number, value:A}Inherited fromListAn item was moved from
oldIndextonewIndex.pushParam { type:
"push", target:Children, newValue:A}Inherited fromListAn item was added to the end of the list.
removeIndexParam { type:
"removeIndex", target:Children, index:number, oldValue:A}Inherited fromListThe item at
indexwas removed.setIndexParam { type:
"setIndex", target:Children, index:number, newValue:A, oldValue:A}Inherited fromListThe item at
indexwas replaced.swapParam { type:
"swap", target:Children, a:A, b:A}Inherited fromListTwo items swapped places.