icy.canvas

Class IcyCanvasEvent

java.lang.Object

icy.canvas.IcyCanvasEvent

All Implemented Interfaces:

CollapsibleEvent

public class IcyCanvasEvent
extends java.lang.Object
implements CollapsibleEvent

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IcyCanvasEvent.IcyCanvasEventType

Constructor Summary

Constructors

Constructor and Description
IcyCanvasEvent(IcyCanvas source, IcyCanvasEvent.IcyCanvasEventType type)
IcyCanvasEvent(IcyCanvas source, IcyCanvasEvent.IcyCanvasEventType type, DimensionId dim)

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.
DimensionId	getDim()
IcyCanvas	getSource()
IcyCanvasEvent.IcyCanvasEventType	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

IcyCanvasEvent

public IcyCanvasEvent(IcyCanvas source,
              IcyCanvasEvent.IcyCanvasEventType type,
              DimensionId dim)

IcyCanvasEvent

public IcyCanvasEvent(IcyCanvas source,
              IcyCanvasEvent.IcyCanvasEventType type)

Method Detail

getSource

public IcyCanvas getSource()

Returns:

the source

getType

public IcyCanvasEvent.IcyCanvasEventType getType()

Returns:

the type

getDim

public DimensionId getDim()

Returns:

the dimension

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