com.yworks.yfiles.base.EdgeList

	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
		EdgeList(init:Boolean = true) Creates an empty edge list.	EdgeList
		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
		edges():EdgeCursor Returns an edge cursor for this edge list.	EdgeList
		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
		firstEdge():Edge Returns the first edge in this list, or null when the list is empty.	EdgeList
		getCell(index:int):ListCell Gets the cell at the given index.	YList
		getClass():Class [override]	EdgeList
		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
		lastEdge():Edge Returns the last edge in this list, or null when the list is empty.	EdgeList
		lastIndexOf(o:Object):int	YList
		listIterator():ListIterator	YList
		listIterator2(index:int):ListIterator	YList
		newEdgeList1():EdgeList [static] Creates an empty edge list.	EdgeList
		newEdgeList2(it:Iterator):EdgeList [static] Creates a list that is initialized with the elements provided by the given Iterator object.	EdgeList
		newEdgeList3(e:Edge):EdgeList [static] Creates a list that is initialized with a single edge provided.	EdgeList
		newEdgeList4(c:EdgeCursor):EdgeList [static] Creates a list that is initialized with the edges provided by the given EdgeCursor object.	EdgeList
		newEdgeList5(edgeList:EdgeList):EdgeList [static] Creates a list that is initialized with an EdgeList.	EdgeList
		newEdgeList6(a:Vector.<Object>):EdgeList [static] Creates a list that is initialized with the edges provided by the given array of edges.	EdgeList
		newEdgeList7(ec:EdgeCursor, predicate:DataProvider):EdgeList [static] Creates a list that is initialized with those edges from the given EdgeCursor object for which the given data provider returns true upon calling its getBool (com.yworks.yfiles.base.DataProvider.getBool()) method.	EdgeList
		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
		peek():Object Equivalent to first().	YList
		pop():Object Removes the first element from this list and returns it.	YList
		popEdge():Edge Removes the first edge from this list and returns it.	EdgeList
		popLast():Object Removes the last element from this list and returns it.	YList
		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
		toEdgeArray():Vector.<Object> Returns an edge array containing all elements of this list in the canonical order.	EdgeList
		toString():String Returns a string representation of this List.	YList

	Method	Defined By
		initEdgeList1():void Initializes this object.	EdgeList
		initEdgeList2(it:Iterator):void Initializes this object.	EdgeList
		initEdgeList3(e:Edge):void Initializes this object.	EdgeList
		initEdgeList4(c:EdgeCursor):void Initializes this object.	EdgeList
		initEdgeList5(edgeList:EdgeList):void Initializes this object.	EdgeList
		initEdgeList6(a:Vector.<Object>):void Initializes this object.	EdgeList
		initEdgeList7(ec:EdgeCursor, predicate:DataProvider):void Initializes this object.	EdgeList
		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

EdgeList

()

Constructor

public function EdgeList(init:Boolean = true)

Creates an empty edge 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

edges

()

method

public function edges():EdgeCursor

Returns an edge cursor for this edge list.

Returns

EdgeCursor — An edge cursor granting access to the edges within this list.

firstEdge

()

method

public function firstEdge():Edge

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

Returns

Edge — The first edge in the list.

getClass

()

method

override public function getClass():Class

Returns

Class

initEdgeList1

()

method

protected final function initEdgeList1():void

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

See also

newEdgeList1()

initEdgeList2

()

method

protected final function initEdgeList2(it:Iterator):void

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

Parameters

it:Iterator

See also

newEdgeList2()

initEdgeList3

()

method

protected final function initEdgeList3(e:Edge):void

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

Parameters

e:Edge

See also

newEdgeList3()

initEdgeList4

()

method

protected final function initEdgeList4(c:EdgeCursor):void

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

Parameters

c:EdgeCursor

See also

newEdgeList4()

initEdgeList5

()

method

protected final function initEdgeList5(edgeList:EdgeList):void

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

Parameters

edgeList:EdgeList

See also

newEdgeList5()

initEdgeList6

()

method

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

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

Parameters

a:Vector.<Object>

See also

newEdgeList6()

initEdgeList7

()

method

protected final function initEdgeList7(ec:EdgeCursor, predicate:DataProvider):void

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

Parameters

	`ec:EdgeCursor`

	`predicate:DataProvider`

See also

newEdgeList7()

lastEdge

()

method

public function lastEdge():Edge

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

Returns

Edge — The last edge in the list.

newEdgeList1

()

method

public static function newEdgeList1():EdgeList

Creates an empty edge list.

Returns

EdgeList

newEdgeList2

()

method

public static function newEdgeList2(it:Iterator):EdgeList

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

Parameters

it:Iterator

Returns

EdgeList

newEdgeList3

()

method

public static function newEdgeList3(e:Edge):EdgeList

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

Parameters

e:Edge

Returns

EdgeList

newEdgeList4

()

method

public static function newEdgeList4(c:EdgeCursor):EdgeList

Creates a list that is initialized with the edges provided by the given EdgeCursor object.

Parameters

c:EdgeCursor

Returns

EdgeList

newEdgeList5

()

method

public static function newEdgeList5(edgeList:EdgeList):EdgeList

Creates a list that is initialized with an EdgeList.

Parameters

edgeList:EdgeList

Returns

EdgeList

newEdgeList6

()

method

public static function newEdgeList6(a:Vector.<Object>):EdgeList

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

Parameters

a:Vector.<Object>

Returns

EdgeList

newEdgeList7

()

method

public static function newEdgeList7(ec:EdgeCursor, predicate:DataProvider):EdgeList

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

Parameters

	`ec:EdgeCursor` — An edge cursor providing edges that should be added to this list.

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

Returns

EdgeList

See also

getBool

popEdge

()

method

public function popEdge():Edge

Removes the first edge from this list and returns it.

Returns

Edge — The first edge from the list.

toEdgeArray

()

method

public function toEdgeArray():Vector.<Object>

Returns an edge 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
EdgeList	Properties \| Methods

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