info.bioinfweb.libralign.dataarea

Class DataAreaChangeEvent

java.lang.Object

java.util.EventObject

info.bioinfweb.libralign.dataarea.DataAreaChangeEvent

All Implemented Interfaces:

java.io.Serializable

public class DataAreaChangeEvent
extends java.util.EventObject

Event that is used to indicate a change of data areas displayed inside an AlignmentArea.

A change in this case means adding, removing or replacing data areas. This event does not indicate changes of the contents of a data area.

Since:

0.0.0

Author:

Ben Stöver

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
DataAreaChangeEvent(java.lang.Object source, boolean eventsFromSingleList, ListChangeType type, java.util.Collection<? extends DataArea> affectedElements) Creates a new event object.
DataAreaChangeEvent(java.lang.Object source, boolean eventsFromSingleList, ListChangeType type, DataArea affectedElement) Creates a new event object.

Method Summary

Modifier and Type	Method and Description
DataArea	getAffectedElement() Returns the first affected element.
java.util.Collection<? extends DataArea>	getAffectedElements()
DataAreasModel	getSource() Returns the model object that contains the list where the change occurred.
ListChangeType	getType() Returns the type of change that happened.
boolean	isEventsFromSingleList() Returns if all elements in getAffectedElements() are contained in the same DataAreaList.

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataAreaChangeEvent

public DataAreaChangeEvent(java.lang.Object source,
                           boolean eventsFromSingleList,
                           ListChangeType type,
                           java.util.Collection<? extends DataArea> affectedElements)

Creates a new event object.

Parameters:

source - the object that manages the data area lists

eventsFromSingleList - Specify true here if all elements in affectedElements are contained in the same DataAreaList.

type - the type of modification that happened

affectedElements - a list of elements that have been affected (inserted, removed or replaced or visibility change)

DataAreaChangeEvent

public DataAreaChangeEvent(java.lang.Object source,
                           boolean eventsFromSingleList,
                           ListChangeType type,
                           DataArea affectedElement)

Creates a new event object. Use this constructor if only one element is affected.

Parameters:

source - the object that manages the data area lists

eventsFromSingleList - Specify true here if all elements in affectedElements are contained in the same DataAreaList.

type - the type of modification that happened

affectedElements - a list of elements that have been affected (inserted, removed or replaced or visibility change)

Method Detail

getSource

public DataAreasModel getSource()

Returns the model object that contains the list where the change occurred.

Overrides:

getSource in class java.util.EventObject

isEventsFromSingleList

public boolean isEventsFromSingleList()

Returns if all elements in getAffectedElements() are contained in the same DataAreaList.

Returns:

true if all elements are from the same list, false otherwise

getType

public ListChangeType getType()

Returns the type of change that happened.

Returns:

a value enumerated by ListChangeType if an element was inserted, removed or replaced or null if the visibility of a data area was changed instead

getAffectedElements

public java.util.Collection<? extends DataArea> getAffectedElements()

getAffectedElement

public DataArea getAffectedElement()

Returns the first affected element. Convenience method if only one element is affected.

Returns:

the fist affected element or null if getAffectedElements() return an empty list