icy.sequence

Class SequenceEvent

java.lang.Object

icy.sequence.SequenceEvent

All Implemented Interfaces:

CollapsibleEvent

public class SequenceEvent
extends java.lang.Object
implements CollapsibleEvent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SequenceEvent.SequenceEventSourceType
static class	SequenceEvent.SequenceEventType

Constructor Summary

Constructors

Constructor and Description
SequenceEvent(Sequence sequence, SequenceEvent.SequenceEventSourceType sourceType)
SequenceEvent(Sequence sequence, SequenceEvent.SequenceEventSourceType sourceType, java.lang.Object source)
SequenceEvent(Sequence sequence, SequenceEvent.SequenceEventSourceType sourceType, java.lang.Object source, int param)
SequenceEvent(Sequence sequence, SequenceEvent.SequenceEventSourceType sourceType, java.lang.Object source, SequenceEvent.SequenceEventType type)
SequenceEvent(Sequence sequence, SequenceEvent.SequenceEventSourceType sourceType, java.lang.Object source, SequenceEvent.SequenceEventType type, int param)
SequenceEvent(Sequence sequence, SequenceEvent.SequenceEventSourceType sourceType, SequenceEvent.SequenceEventType type)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	collapse(CollapsibleEvent event) Collapse current object/event with specified one.
boolean	equals(java.lang.Object obj) Returns true if the current event is equivalent to the specified one.
int	getParam() Extra parameter of event.
Sequence	getSequence()
java.lang.Object	getSource() Source object of the event.
SequenceEvent.SequenceEventSourceType	getSourceType() SourceType define the object type of source The following source types are available: SEQUENCE_TYPE --> source object is null SEQUENCE_META --> source object define the meta data id (String) It can be null (consider global metadata change) SEQUENCE_COLORMAP --> source object is an instance of IcyColorModel SEQUENCE_COMPONENTBOUNDS --> source object is an instance of IcyColorModel SEQUENCE_DATA --> source object is an instance of IcyBufferedImage source object can be null when severals images has been modified SEQUENCE_ROI --> source object is an instance of ROI source object can be null when severals images has been modified SEQUENCE_OVERLAY --> source object is an instance of Overlay source object can be null when severals images has been modified SEQUENCE_PAINTER --> source object is an instance of Painter source object can be null when severals images has been modified
SequenceEvent.SequenceEventType	getType() Type define the type of event.
int	hashCode() Returns hash code for current event.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SequenceEvent

public SequenceEvent(Sequence sequence,
             SequenceEvent.SequenceEventSourceType sourceType)

SequenceEvent

public SequenceEvent(Sequence sequence,
             SequenceEvent.SequenceEventSourceType sourceType,
             java.lang.Object source)

SequenceEvent

public SequenceEvent(Sequence sequence,
             SequenceEvent.SequenceEventSourceType sourceType,
             java.lang.Object source,
             int param)

SequenceEvent

public SequenceEvent(Sequence sequence,
             SequenceEvent.SequenceEventSourceType sourceType,
             SequenceEvent.SequenceEventType type)

SequenceEvent

public SequenceEvent(Sequence sequence,
             SequenceEvent.SequenceEventSourceType sourceType,
             java.lang.Object source,
             SequenceEvent.SequenceEventType type)

SequenceEvent

public SequenceEvent(Sequence sequence,
             SequenceEvent.SequenceEventSourceType sourceType,
             java.lang.Object source,
             SequenceEvent.SequenceEventType type,
             int param)

Method Detail

getSequence

public Sequence getSequence()

Returns:

the sequence

getSourceType

public SequenceEvent.SequenceEventSourceType getSourceType()

SourceType define the object type of source

The following source types are available:
SEQUENCE_TYPE --> source object is null
SEQUENCE_META --> source object define the meta data id (String)
It can be null (consider global metadata change)
SEQUENCE_COLORMAP --> source object is an instance of IcyColorModel
SEQUENCE_COMPONENTBOUNDS --> source object is an instance of IcyColorModel
SEQUENCE_DATA --> source object is an instance of IcyBufferedImage
source object can be null when severals images has been modified
SEQUENCE_ROI --> source object is an instance of ROI
source object can be null when severals images has been modified
SEQUENCE_OVERLAY --> source object is an instance of Overlay
source object can be null when severals images has been modified
SEQUENCE_PAINTER --> source object is an instance of Painter
source object can be null when severals images has been modified

getSource

public java.lang.Object getSource()

Source object of the event.
The object type here depend of the sourceType value.

getType

public SequenceEvent.SequenceEventType getType()

Type define the type of event.

When sourceType is one of the following :
SEQUENCE_TYPE, SEQUENCE_META, SEQUENCE_COLORMAP, SEQUENCE_COMPONENTBOUNDS
the type can only be SequenceEventType.CHANGED

When sourceType is one of the following :
SEQUENCE_DATA, SEQUENCE_ROI, SEQUENCE_PAINTER, SEQUENCE_OVERLAY
the type can also be SequenceEventType.ADDED or SequenceEventType.REMOVED
That mean a specific image, roi or painter (if source != null) has been added or removed from the sequence.
If source == null that mean we have a global change event and some stuff need to be recalculated.
Severals ADDED / CHANGED / REMOVE events can be compacted to one CHANGED event with a null source (global change) for SEQUENCE_DATA source type.

getParam

public int getParam()

Extra parameter of event.

It's used to specify the component number when sourceType is SEQUENCE_COLORMAP or SEQUENCE_COMPONENTBOUNDS (in both case source is instance of IcyColorModel).
Also used internally...

collapse

public boolean collapse(CollapsibleEvent event)

Description copied from interface: CollapsibleEvent

Collapse current object/event with specified one.

Specified by:

collapse in interface CollapsibleEvent

Returns:

false if collapse operation failed (object are not 'equals')

hashCode

public int hashCode()

Description copied from interface: CollapsibleEvent

Returns hash code for current event. It should respect the default Object.hashCode() contract.

Specified by:

hashCode in interface CollapsibleEvent

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: CollapsibleEvent

Returns true if the current event is equivalent to the specified one.
We want event to override Object.equals(Object) method as we use an HashMap to store these event in the UpdateEventHandler class.

Specified by:

equals in interface CollapsibleEvent

Overrides:

equals in class java.lang.Object