com.yworks.yfiles.base.NodeList

	Property	Defined By
		empty : Boolean [read-only] Checks whether this list contains elements.	YList
		length : int [read-only] Returns the number of elements in this list.	YList

Public Methods

	Method		Defined By
		NodeList(init:Boolean = true) Creates an empty node list.	NodeList
		addAll(collection:Collection):Boolean Appends all elements provided by the given collection to this list.	YList
		addAllAt(index:int, c:Collection):Boolean	YList
		addAllFromCursor(c:YCursor):void Appends all elements provided by the given cursor to this list.	YList
		addFirst(o:Object):ListCell Inserts the given object at the head of this list.	YList
		addFirstCell(cell:ListCell):void Adds a formerly removed ListCell object at the head of this list.	YList
		addItem(o:Object):Boolean Same as addLast().	YList
		addItemAt(index:int, element:Object):void	YList
		addLast(o:Object):ListCell Inserts the given object at the tail of this list.	YList
		addLastCell(cell:ListCell):void Adds a formerly removed ListCell object at the tail of this list.	YList
		clear():void Removes all elements from this list.	YList
		containsAll(collection:Collection):Boolean Whether or not this list contains all the elements in the given collection.	YList
		containsItem(o:Object):Boolean Whether or not this list contains the given element.	YList
		cursor():YCursor Returns a cursor for this list.	YList
		cyclicPred(c:ListCell):ListCell Returns the cyclic predecessor cell of the given list cell.	YList
		cyclicSucc(c:ListCell):ListCell Returns the cyclic successor cell of the given list cell.	YList
		elementAt(i:int):Object Returns the i-th element of this list.	YList
		equals(other:Object):Boolean [override]	YList
		findCell(o:Object):ListCell Returns the com.yworks.yfiles.base.ListCell where object o is stored.	YList
		first():Object Returns the first element of this list.	YList
		firstCell():ListCell Returns the first cell of this list.	YList
		firstNode():Node Returns the first node in this list, or null when the list is empty.	NodeList
		getCell(index:int):ListCell Gets the cell at the given index.	YList
		getClass():Class [override]	NodeList
		getInfo(c:ListCell):Object Returns the element stored in the given list cell.	YList
		getItemAt(index:int):Object	YList
		hashCode():int [override]	YList
		indexOf(obj:Object):int Returns the zero-based index of the given element in this list.	YList
		insertAfter(o:Object, refCell:ListCell):ListCell Inserts the given object into this list with respect to a given reference list cell.	YList
		insertBefore(o:Object, refCell:ListCell):ListCell Inserts the given object into this list with respect to a given reference list cell.	YList
		insertCellAfter(cellToInsert:ListCell, refCell:ListCell):void Inserts a formerly removed ListCell object into this list with respect to a given reference list cell.	YList
		insertCellBefore(cellToInsert:ListCell, refCell:ListCell):void Inserts a formerly removed ListCell object into this list with respect to a given reference list cell.	YList
		iterator():Iterator Returns an iterator for that list.	YList
		last():Object Returns the last element of this list.	YList
		lastCell():ListCell Returns the last cell of this list.	YList
		lastIndexOf(o:Object):int	YList
		lastNode():Node Returns the last node in this list, or null when the list is empty.	NodeList
		listIterator():ListIterator	YList
		listIterator2(index:int):ListIterator	YList
		newNodeList1():NodeList [static] Creates an empty node list.	NodeList
		newNodeList2(it:Iterator):NodeList [static] Creates a list that is initialized with the elements provided by the given Iterator object.	NodeList
		newNodeList3(v:Node):NodeList [static] Creates a list that is initialized with a single node provided.	NodeList
		newNodeList4(c:NodeCursor):NodeList [static] Creates a list that is initialized with the nodes provided by the given NodeCursor object.	NodeList
		newNodeList5(list:NodeList):NodeList [static] Creates a list that is initialized with the entries of the given list.	NodeList
		newNodeList6(a:Vector.<Object>):NodeList [static] Creates a list that is initialized with the nodes provided by the given array of nodes.	NodeList
		newNodeList7(nc:NodeCursor, predicate:DataProvider):NodeList [static] Creates a list that is initialized with those nodes from the given NodeCursor object for which the given data provider returns true upon calling its getBool (com.yworks.yfiles.base.DataProvider.getBool()) method.	NodeList
		newYList1():YList [static] Creates an empty doubly linked list.	YList
		newYList2(a:Vector.<Object>):YList [static] Creates a list that is initialized with the elements provided by the given array of objects.	YList
		newYList3(c:Collection):YList [static] Creates a list that is initialized with the elements provided by the given Collection object.	YList
		newYList4(it:Iterator):YList [static] Creates a list that is initialized with the elements provided by the given Iterator object.	YList
		newYList5(c:YCursor):YList [static] Creates a list that is initialized with the elements provided by the given YCursor object.	YList
		newYList6(c:YCursor, predicate:DataProvider):YList [static] Creates a list that is initialized with those elements from the given YCursor object for which the given data provider returns true upon calling its getBool (com.yworks.yfiles.base.DataProvider.getBool()) method.	YList
		nodes():NodeCursor Returns a node cursor for this node list.	NodeList
		peek():Object Equivalent to first().	YList
		pop():Object Removes the first element from this list and returns it.	YList
		popLast():Object Removes the last element from this list and returns it.	YList
		popNode():Node Removes the first node from this list and returns it.	NodeList
		predCell(c:ListCell):ListCell Returns the predecessor cell of the given list cell.	YList
		push(o:Object):ListCell Equivalent to addFirst().	YList
		removeAll(collection:Collection):Boolean Removes the given collection of objects from this list.	YList
		removeAt(c:YCursor):Object Removes the element pointed to by the given YCursor object.	YList
		removeCell(c:ListCell):Object Removes the given list cell, and hence the element stored in it, from this list.	YList
		removeItem(o:Object):Boolean Removes the given object from this list.	YList
		removeItemAt(index:int):Object	YList
		retainAll(collection:Collection):Boolean Retains only those elements in this list which are contained in the given collection.	YList
		reverse():void Reverses the sequence of elements in this list.	YList
		setInfo(c:ListCell, value:Object):void Updates the element stored in the given list cell with the given object.	YList
		setItemAt(index:int, element:Object):Object	YList
		sort(comp:Comparator):void Sorts the elements in this list according to the given comparator.	YList
		sort2():void Sorts the elements in this list into ascending order, according to their natural ordering.	YList
		splice(list:YList):void Transfers the contents of the given list to the end of this list.	YList
		subList(fromIndex:int, toIndex:int):List	YList
		succCell(c:ListCell):ListCell Returns the successor cell of the given list cell.	YList
		toArray():Vector.<Object> Returns an array representation of this list.	YList
		toArray2(a:Vector.<Object>):Vector.<Object> Returns an array containing all list elements in the correct order.	YList
		toNodeArray():Vector.<Object> Returns a node array containing all elements of this list in the canonical order.	NodeList
		toString():String Returns a string representation of this List.	YList

	Method	Defined By
		initNodeList1():void Initializes this object.	NodeList
		initNodeList2(it:Iterator):void Initializes this object.	NodeList
		initNodeList3(v:Node):void Initializes this object.	NodeList
		initNodeList4(c:NodeCursor):void Initializes this object.	NodeList
		initNodeList5(list:NodeList):void Initializes this object.	NodeList
		initNodeList6(a:Vector.<Object>):void Initializes this object.	NodeList
		initNodeList7(nc:NodeCursor, predicate:DataProvider):void Initializes this object.	NodeList
		initYList1():void Initializes this object.	YList
		initYList2(a:Vector.<Object>):void Initializes this object.	YList
		initYList3(c:Collection):void Initializes this object.	YList
		initYList4(it:Iterator):void Initializes this object.	YList
		initYList5(c:YCursor):void Initializes this object.	YList
		initYList6(c:YCursor, predicate:DataProvider):void Initializes this object.	YList

Constructor Detail

NodeList

()

Constructor

public function NodeList(init:Boolean = true)

Creates an empty node list.

Parameters

init:Boolean (default = true) — An internally used switch to help handle proper instance initialization in inheritance chains where classes can have multiple constructor-like factory methods. This parameter can safely be ignored/omitted when calling the constructor.

Method Detail

firstNode

()

method

public function firstNode():Node

Returns the first node in this list, or null when the list is empty.

Returns

Node — The first node in the list.

getClass

()

method

override public function getClass():Class

Returns

Class

initNodeList1

()

method

protected final function initNodeList1():void

Initializes this object. See the documentation of the corresponding factory method newNodeList1() for details.

See also

newNodeList1()

initNodeList2

()

method

protected final function initNodeList2(it:Iterator):void

Initializes this object. See the documentation of the corresponding factory method newNodeList2() for details.

Parameters

it:Iterator

See also

newNodeList2()

initNodeList3

()

method

protected final function initNodeList3(v:Node):void

Initializes this object. See the documentation of the corresponding factory method newNodeList3() for details.

Parameters

v:Node

See also

newNodeList3()

initNodeList4

()

method

protected final function initNodeList4(c:NodeCursor):void

Initializes this object. See the documentation of the corresponding factory method newNodeList4() for details.

Parameters

c:NodeCursor

See also

newNodeList4()

initNodeList5

()

method

protected final function initNodeList5(list:NodeList):void

Initializes this object. See the documentation of the corresponding factory method newNodeList5() for details.

Parameters

list:NodeList

See also

newNodeList5()

initNodeList6

()

method

protected final function initNodeList6(a:Vector.<Object>):void

Initializes this object. See the documentation of the corresponding factory method newNodeList6() for details.

Parameters

a:Vector.<Object>

See also

newNodeList6()

initNodeList7

()

method

protected final function initNodeList7(nc:NodeCursor, predicate:DataProvider):void

Initializes this object. See the documentation of the corresponding factory method newNodeList7() for details.

Parameters

	`nc:NodeCursor`

	`predicate:DataProvider`

See also

newNodeList7()

lastNode

()

method

public function lastNode():Node

Returns the last node in this list, or null when the list is empty.

Returns

Node — The last node in the list.

newNodeList1

()

method

public static function newNodeList1():NodeList

Creates an empty node list.

Returns

NodeList

newNodeList2

()

method

public static function newNodeList2(it:Iterator):NodeList

Creates a list that is initialized with the elements provided by the given Iterator object.

Parameters

it:Iterator

Returns

NodeList

newNodeList3

()

method

public static function newNodeList3(v:Node):NodeList

Creates a list that is initialized with a single node provided.

Parameters

v:Node

Returns

NodeList

newNodeList4

()

method

public static function newNodeList4(c:NodeCursor):NodeList

Creates a list that is initialized with the nodes provided by the given NodeCursor object.

Parameters

c:NodeCursor

Returns

NodeList

newNodeList5

()

method

public static function newNodeList5(list:NodeList):NodeList

Creates a list that is initialized with the entries of the given list.

Parameters

list:NodeList — the values are added to the new list

Returns

NodeList

newNodeList6

()

method

public static function newNodeList6(a:Vector.<Object>):NodeList

Creates a list that is initialized with the nodes provided by the given array of nodes.

Parameters

a:Vector.<Object>

Returns

NodeList

newNodeList7

()

method

public static function newNodeList7(nc:NodeCursor, predicate:DataProvider):NodeList

Creates a list that is initialized with those nodes from the given NodeCursor object for which the given data provider returns true upon calling its getBool (com.yworks.yfiles.base.DataProvider.getBool()) method.

Parameters

	`nc:NodeCursor` — A node cursor providing nodes that should be added to this list.

	`predicate:DataProvider` — A data provider that acts as a inclusion predicate for each node accessible by the given node cursor.

Returns

NodeList

See also

getBool

nodes

()

method

public function nodes():NodeCursor

Returns a node cursor for this node list.

Returns

NodeCursor — A node cursor granting access to the nodes within this list.

popNode

()

method

public function popNode():Node

Removes the first node from this list and returns it.

Returns

Node — The first node from the list.

toNodeArray

()

method

public function toNodeArray():Vector.<Object>

Returns a node array containing all elements of this list in the canonical order.

Returns

Vector.<Object>

Wed Oct 7 2015, 04:43 PM +02:00

yFiles FLEX Client Layout Extension 1.5 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
NodeList	Properties \| Methods

Package	com.yworks.yfiles.base
Class	public class NodeList
Inheritance	NodeList YList YObject Object