com.yworks.yfiles.layout.router.polyline.PartitionCell

	Property	Defined By
		bounds : YRectangle [read-only] Returns the bounds the partition cell.	PartitionCell
		height : Number [read-only] Returns the height of this partition cell.	PartitionCell
		id : int [read-only] Returns a unique identifier of this partition cell.	PartitionCell
		maxX : Number [read-only] Returns the x value of the right border of this partition cell.	PartitionCell
		maxY : Number [read-only] Returns the y value of the lower border of this partition cell.	PartitionCell
		minX : Number [read-only] Returns the x value of the left border of this partition cell.	PartitionCell
		minY : Number [read-only] Returns the y value of the upper border of this partition cell.	PartitionCell
		partition : Partition [read-only] Returns the partition (com.yworks.yfiles.layout.router.polyline.DynamicObstacleDecomposition) to which this partition cell belongs.	PartitionCell
		width : Number [read-only] Returns the width of this partition cell.	PartitionCell

	Method	Defined By
		PartitionCell(bounds:YRectangle, partition:Partition, init:Boolean = true) Creates a new partition cell of the given partition with location and size of the given rectangle.	PartitionCell
		clearData():void Clears all additional data.	PartitionCell
		createBorderInterval(border:PartitionCell_PartitionCellBorder):OrthogonalInterval Returns an com.yworks.yfiles.layout.router.polyline.OrthogonalInterval that defines location, size and orientation of the given border.	PartitionCell
		equals(o:Object):Boolean	YObject
		getClass():Class [override]	PartitionCell
		getData(key:Object):Object Returns additional data to which the given key is mapped for this partition cell.	PartitionCell
		hashCode():int	YObject
		newPartitionCell1(bounds:YRectangle, partition:Partition):PartitionCell [static] Creates a new partition cell of the given partition with location and size of the given rectangle.	PartitionCell
		newPartitionCell2(x:Number, y:Number, width:Number, height:Number, partition:Partition):PartitionCell [static] Creates a new partition cell of the given partition with the given bounds.	PartitionCell
		putData(key:Object, data:Object):Object Stores additional data to which the given key is mapped for this partition cell.	PartitionCell
		removeData(key:Object):Object Removes additional data to which the given key is mapped for this partition cell.	PartitionCell

	Method	Defined By
		initPartitionCell1(bounds:YRectangle, partition:Partition):void Initializes this object.	PartitionCell
		initPartitionCell2(x:Number, y:Number, width:Number, height:Number, partition:Partition):void Initializes this object.	PartitionCell

Property Detail

bounds

property

bounds:YRectangle [read-only]

Returns the bounds the partition cell.

Implementation
public function get bounds():YRectangle

height

property

height:Number [read-only]

Returns the height of this partition cell.

Implementation
public function get height():Number

property

id:int [read-only]

Returns a unique identifier of this partition cell.

Implementation
public function get id():int

maxX

property

maxX:Number [read-only]

Returns the x value of the right border of this partition cell.

Implementation
public function get maxX():Number

maxY

property

maxY:Number [read-only]

Returns the y value of the lower border of this partition cell.

Implementation
public function get maxY():Number

minX

property

minX:Number [read-only]

Returns the x value of the left border of this partition cell.

Implementation
public function get minX():Number

minY

property

minY:Number [read-only]

Returns the y value of the upper border of this partition cell.

Implementation
public function get minY():Number

partition

property

partition:Partition [read-only]

Returns the partition (com.yworks.yfiles.layout.router.polyline.DynamicObstacleDecomposition) to which this partition cell belongs.

Implementation
public function get partition():Partition

width

property

width:Number [read-only]

Returns the width of this partition cell.

Implementation
public function get width():Number

Constructor Detail

PartitionCell

()

Constructor

public function PartitionCell(bounds:YRectangle, partition:Partition, init:Boolean = true)

Creates a new partition cell of the given partition with location and size of the given rectangle.

Parameters

	`bounds:YRectangle` — The bounds of the partition cell.

	`partition:Partition` — The partition to which the partition cell belongs.

	`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

clearData

()

method

public function clearData():void

Clears all additional data.

See also

getData()
putData()
removeData()

createBorderInterval

()

method

public function createBorderInterval(border:PartitionCell_PartitionCellBorder):OrthogonalInterval

Returns an com.yworks.yfiles.layout.router.polyline.OrthogonalInterval that defines location, size and orientation of the given border. The values defining the border are

com.yworks.yfiles.layout.router.polyline.PartitionCell_PartitionCellBorder.WEST
com.yworks.yfiles.layout.router.polyline.PartitionCell_PartitionCellBorder.EAST
com.yworks.yfiles.layout.router.polyline.PartitionCell_PartitionCellBorder.NORTH
com.yworks.yfiles.layout.router.polyline.PartitionCell_PartitionCellBorder.SOUTH

Parameters

border:PartitionCell_PartitionCellBorder — A border of this partition cell.

Returns

OrthogonalInterval — An com.yworks.yfiles.layout.router.polyline.OrthogonalInterval that defines location, size and orientation of the given border.

getClass

()

method

override public function getClass():Class

Returns

Class

getData

()

method

public function getData(key:Object):Object

Returns additional data to which the given key is mapped for this partition cell.

Parameters

key:Object — The Key with which the given data is to be associated.

Returns

Object — The additional data to which the given key is mapped, or null if there was no mapping for key.

initPartitionCell1

()

method

protected final function initPartitionCell1(bounds:YRectangle, partition:Partition):void

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

Parameters

	`bounds:YRectangle`

	`partition:Partition`

See also

newPartitionCell1()

initPartitionCell2

()

method

protected final function initPartitionCell2(x:Number, y:Number, width:Number, height:Number, partition:Partition):void

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

Parameters

	`x:Number`

	`y:Number`

	`width:Number`

	`height:Number`

	`partition:Partition`

See also

newPartitionCell2()

newPartitionCell1

()

method

public static function newPartitionCell1(bounds:YRectangle, partition:Partition):PartitionCell

Creates a new partition cell of the given partition with location and size of the given rectangle.

Parameters

	`bounds:YRectangle` — The bounds of the partition cell.

	`partition:Partition` — The partition to which the partition cell belongs.

Returns

PartitionCell

newPartitionCell2

()

method

 public static function newPartitionCell2(x:Number, y:Number, width:Number, height:Number, partition:Partition):PartitionCell

Creates a new partition cell of the given partition with the given bounds.

Parameters

	`x:Number` — The x-coordinate of upper left corner of the partition cell.

	`y:Number` — The y-coordinate of upper left corner of the partition cell.

	`width:Number` — The width of the partition cell.

	`height:Number` — The height of the partition cell.

	`partition:Partition` — The partition to which the partition cell belongs.

Returns

PartitionCell

putData

()

method

public function putData(key:Object, data:Object):Object

Stores additional data to which the given key is mapped for this partition cell.

Parameters

	`key:Object` — The key with which the given data is to be associated.

	`data:Object` — The additional data.

Returns

Object — The previous data associated with key, or null if there was no mapping for key.

removeData

()

method

public function removeData(key:Object):Object

Removes additional data to which the given key is mapped for this partition cell.

Parameters

key:Object — The Key with which the given data is to be associated.

Returns

Object — The additional data to which the given key is mapped, or null if there was no mapping for key.

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
PartitionCell	Properties \| Methods

Package	com.yworks.yfiles.layout.router.polyline
Class	public class PartitionCell
Inheritance	PartitionCell YObject Object