icy.roi

Class ROIEvent

java.lang.Object

icy.roi.ROIEvent

All Implemented Interfaces:

CollapsibleEvent

public class ROIEvent
extends java.lang.Object
implements CollapsibleEvent

Author:

stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ROIEvent.ROIEventType
static class	ROIEvent.ROIPointEventType Deprecated.

Constructor Summary

Constructors

Constructor and Description
ROIEvent(ROI source, ROIEvent.ROIEventType type)
ROIEvent(ROI source, ROIEvent.ROIEventType type, ROIEvent.ROIPointEventType pointEventType, java.lang.Object point) Deprecated. Use ROIEvent(ROI, ROIEventType) constructor instead
ROIEvent(ROI source, ROIEvent.ROIEventType type, java.lang.String propertyName)
ROIEvent(ROI source, java.lang.String propertyName)

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.
java.lang.Object	getPoint() Deprecated.
ROIEvent.ROIPointEventType	getPointEventType() Deprecated.
java.lang.String	getPropertyName()
ROI	getSource()
ROIEvent.ROIEventType	getType()
int	hashCode() Returns hash code for current event.

Methods inherited from class java.lang.Object

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

Constructor Detail

ROIEvent

@Deprecated
public ROIEvent(ROI source,
                   ROIEvent.ROIEventType type,
                   ROIEvent.ROIPointEventType pointEventType,
                   java.lang.Object point)

Deprecated. Use ROIEvent(ROI, ROIEventType) constructor instead

ROIEvent

public ROIEvent(ROI source,
        ROIEvent.ROIEventType type,
        java.lang.String propertyName)

ROIEvent

public ROIEvent(ROI source,
        java.lang.String propertyName)

ROIEvent

public ROIEvent(ROI source,
        ROIEvent.ROIEventType type)

Method Detail

getSource

public ROI getSource()

Returns:

the source

getType

public ROIEvent.ROIEventType getType()

Returns:

the type

getPropertyName

public java.lang.String getPropertyName()

Returns:

the propertyName

getPoint

@Deprecated
public java.lang.Object getPoint()

Deprecated.

getPointEventType

@Deprecated
public ROIEvent.ROIPointEventType getPointEventType()

Deprecated.

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