BiAreaCollection

This collection contains BiArea objects This implements the same interface as BiSelectionItemCollection

This class extends BiObject and therefore all methods and fields available for BiObject are also available for BiAreaCollection .

Constructor

new BiAreaCollection ( )

Parameters

No parameters.

Properties

Name	Type	get	set	Descripton
changeValue	Object			This is used by BiSelectionModel to compare whether the collection has changed. Two identical collections should always return the same value. If a change has occured the change value must also change

Methods

Name	Description
add	Adds an area to the collection. This does not check whether the area might intersect with any of the existing areas in the collection
contains	Whether the collection contains the area. This also returns true if one of the areas in the collection completely encloses the area.
getItemHashCode	Returns an identifier for the area
hitTest	Tests whether a point is inside any of the areas in the collection
isEmpty	Whether the collection is empty
remove	Removes an area from the collection.
removeAll	Removes all the areas in the collection making it empty
toArray	Returns an array containing the areas in the collection

Events

None.

Static Methods

None.

Static Fields

None.

Remarks

Method Details

add

Adds an area to the collection. This does not check whether the area might intersect with any of the existing areas in the collection

Syntax

object.add
 (
 oArea
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oArea	BiArea			The area to add

Return Type

void

contains

Whether the collection contains the area. This also returns true if one of the areas in the collection completely encloses the area.

Syntax

object.contains
 (
 oArea
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oArea	BiArea			The area to test whether the collection contains

Return Type

Boolean

getItemHashCode

Returns an identifier for the area

Syntax

object.getItemHashCode
 (
 oItem
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oItem	BiArea			The area to get the identifier for

Return Type

String

hitTest

Tests whether a point is inside any of the areas in the collection

Syntax

object.hitTest
 (
 x,y
 )
 

Parameters

Name	Type	Optional	Default	Descripton
x	Number			The x coordinate
y	Number			The y coordinate

Return Type

Boolean

isEmpty

Whether the collection is empty

Syntax

object.isEmpty
 (
 
 )
 

Parameters

No arguments.

Return Type

Boolean

remove

Removes an area from the collection.

Syntax

object.remove
 (
 oArea
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oArea	BiArea			The area to remove

Return Type

void

removeAll

Removes all the areas in the collection making it empty

Syntax

object.removeAll
 (
 
 )
 

Parameters

No arguments.

Return Type

void

toArray

Returns an array containing the areas in the collection

Syntax

object.toArray
 (
 
 )
 

Parameters

No arguments.

Return Type

BiArea[]