com.pentec.gui.aoi
Interface AoiList

All Known Implementing Classes:

AoiListAdapter

public interface AoiList

List of AOIs

Author:

Pender Technology

Method Summary

boolean	add(AOI aoi) Add an AOI to the list
boolean	addChangeListener(AoiListChangeListener aoiListChangeListener) Add an AOI list change listener
AOI	get(int iIndex) Get an AOI in the list at the requested index
AOI[]	getByType(java.lang.Class type) Get all the AOIs of a particular class type
AoiListChangeListener[]	getChangeListeners() Get the AOI list change listeners currently registered
boolean	remove(AOI aoi) Remove an AOI from the list
AOI	remove(int iIndex) Remove an AOI from the list at the requested index
boolean	removeChangeListener(AoiListChangeListener aoiListChangeListener) Remove an AOI list change listener
AOI[]	toArray() Convert the list to an array of AOIs

Method Detail

add

boolean add(AOI aoi)

Add an AOI to the list

Parameters:

aoi - AOI to add to the list

Returns:

true on successful add, false otherwise

addChangeListener

boolean addChangeListener(AoiListChangeListener aoiListChangeListener)

Add an AOI list change listener

Parameters:

aoiListChangeListener - listener to add

Returns:

true on success, false otherwise

get

AOI get(int iIndex)

Get an AOI in the list at the requested index

Parameters:

iIndex - index of the AOI

Returns:

AOI in the list at the requested index

getByType

AOI[] getByType(java.lang.Class type)

Get all the AOIs of a particular class type

Parameters:

type - class type of AOIs to search for

Returns:

array of AOIs of the requested class type (array size will be 0 if none are found)

getChangeListeners

AoiListChangeListener[] getChangeListeners()

Get the AOI list change listeners currently registered

Returns:

array of AOI list change listeners currently registered

remove

boolean remove(AOI aoi)

Remove an AOI from the list

Parameters:

aoi - AOI to remove from the list

Returns:

true on successful removal, false otherwise

remove

AOI remove(int iIndex)

Remove an AOI from the list at the requested index

Parameters:

iIndex - index of the AOI

Returns:

AOI removed or null on failure

removeChangeListener

boolean removeChangeListener(AoiListChangeListener aoiListChangeListener)

Remove an AOI list change listener

Parameters:

aoiListChangeListener - change listener to remove

Returns:

true on success, false otherwise

toArray

AOI[] toArray()

Convert the list to an array of AOIs

Returns:

AOI array version of the list