icy.canvas

Class Layer

java.lang.Object

icy.canvas.Layer

All Implemented Interfaces:

OverlayListener, java.lang.Comparable<Layer>, java.util.EventListener

public class Layer
extends java.lang.Object
implements OverlayListener, java.lang.Comparable<Layer>

Layer class.
This class encapsulate Overlay in a canvas to
add specific display properties (visibility, transparency...).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Layer.LayerListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NAME
static java.lang.String	PROPERTY_ALPHA Deprecated. Use PROPERTY_OPACITY instead
static java.lang.String	PROPERTY_CANBEREMOVED
static java.lang.String	PROPERTY_NAME
static java.lang.String	PROPERTY_OPACITY
static java.lang.String	PROPERTY_PRIORITY
static java.lang.String	PROPERTY_READONLY
static java.lang.String	PROPERTY_RECEIVEKEYEVENTONHIDDEN
static java.lang.String	PROPERTY_RECEIVEMOUSEEVENTONHIDDEN
static java.lang.String	PROPERTY_VISIBLE

Constructor Summary

Constructors

Constructor and Description
Layer(Overlay overlay)
Layer(Painter painter) Deprecated. Use Layer(Overlay) instead.
Layer(Painter painter, java.lang.String name) Deprecated. Use Layer(Overlay) instead.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Layer.LayerListener listener) Add a listener
int	compareTo(Layer layer)
float	getAlpha() Deprecated. Use getOpacity() instead
ROI	getAttachedROI()
boolean	getCanBeRemoved() Returns true if the layer can be freely removed from the Canvas where it appears and false otherwise.
java.lang.String	getName() Returns layer name (internally use the overlay name).
float	getOpacity()
Overlay	getOverlay() Returns the attached Overlay.
Painter	getPainter() Deprecated. Use getOverlay() instead.
Overlay.OverlayPriority	getPriority() Returns layer priority (internally use the overlay priority).
boolean	getReceiveKeyEventOnHidden()
boolean	getReceiveMouseEventOnHidden()
boolean	isFixed() Deprecated. Use getCanBeRemoved() instead.
static boolean	isPaintProperty(java.lang.String propertyName) Returns true if the Layer need to be repainted when the specified property has changed.
boolean	isReadOnly() Returns the read only property name (internally use the overlay read only property).
boolean	isVisible()
void	overlayChanged(OverlayEvent event)
void	removeListener(Layer.LayerListener listener) Remove a listener
void	setAlpha(float value) Deprecated. Use setOpacity(float) instead.
void	setCanBeRemoved(boolean value) Set the canBeRemoved property.
void	setFixed(boolean value) Deprecated. Use setCanBeRemoved(boolean) instead.
void	setName(java.lang.String name) Set the layer name (internally set the overlay name)
void	setOpacity(float value) Set the layer opacity
void	setPriority(Overlay.OverlayPriority priority) Set the layer priority (internally set the overlay priority).
void	setReadOnly(boolean readOnly) Set read only property (internally set the overlay read only property).
void	setReceiveKeyEventOnHidden(boolean value)
void	setReceiveMouseEventOnHidden(boolean value)
void	setVisible(boolean visible)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_NAME

public static final java.lang.String PROPERTY_NAME

See Also:

Constant Field Values

PROPERTY_PRIORITY

public static final java.lang.String PROPERTY_PRIORITY

See Also:

Constant Field Values

PROPERTY_READONLY

public static final java.lang.String PROPERTY_READONLY

See Also:

Constant Field Values

PROPERTY_CANBEREMOVED

public static final java.lang.String PROPERTY_CANBEREMOVED

See Also:

Constant Field Values

PROPERTY_RECEIVEKEYEVENTONHIDDEN

public static final java.lang.String PROPERTY_RECEIVEKEYEVENTONHIDDEN

See Also:

Constant Field Values

PROPERTY_RECEIVEMOUSEEVENTONHIDDEN

public static final java.lang.String PROPERTY_RECEIVEMOUSEEVENTONHIDDEN

See Also:

Constant Field Values

PROPERTY_ALPHA

@Deprecated
public static final java.lang.String PROPERTY_ALPHA

Deprecated. Use PROPERTY_OPACITY instead

See Also:

Constant Field Values

PROPERTY_OPACITY

public static final java.lang.String PROPERTY_OPACITY

See Also:

Constant Field Values

PROPERTY_VISIBLE

public static final java.lang.String PROPERTY_VISIBLE

See Also:

Constant Field Values

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

See Also:

Constant Field Values

Constructor Detail

Layer

public Layer(Overlay overlay)

Layer

@Deprecated
public Layer(Painter painter,
                java.lang.String name)

Deprecated. Use Layer(Overlay) instead.

Layer

@Deprecated
public Layer(Painter painter)

Deprecated. Use Layer(Overlay) instead.

Method Detail

isPaintProperty

public static boolean isPaintProperty(java.lang.String propertyName)

Returns true if the Layer need to be repainted when the specified property has changed.

getOverlay

public Overlay getOverlay()

Returns the attached Overlay.

getPainter

@Deprecated
public Painter getPainter()

Deprecated. Use getOverlay() instead.

getPriority

public Overlay.OverlayPriority getPriority()

Returns layer priority (internally use the overlay priority).

See Also:

Overlay.getPriority()

setPriority

public void setPriority(Overlay.OverlayPriority priority)

Set the layer priority (internally set the overlay priority).

See Also:

Overlay.setPriority(OverlayPriority)

getName

public java.lang.String getName()

Returns layer name (internally use the overlay name).

See Also:

Overlay.getName()

setName

public void setName(java.lang.String name)

Set the layer name (internally set the overlay name)

See Also:

Overlay.setName(String)

isReadOnly

public boolean isReadOnly()

Returns the read only property name (internally use the overlay read only property).

See Also:

Overlay.isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

Set read only property (internally set the overlay read only property).

See Also:

Overlay.setReadOnly(boolean)

isFixed

@Deprecated
public boolean isFixed()

Deprecated. Use getCanBeRemoved() instead.

Returns fixed property.

setFixed

@Deprecated
public void setFixed(boolean value)

Deprecated. Use setCanBeRemoved(boolean) instead.

getCanBeRemoved

public boolean getCanBeRemoved()

Returns true if the layer can be freely removed from the Canvas where it appears and false otherwise.

See Also:

Overlay.getCanBeRemoved()

setCanBeRemoved

public void setCanBeRemoved(boolean value)

Set the canBeRemoved property.
Set it to false if you want to prevent the layer to be removed from the Canvas where it appears.

See Also:

Overlay.setCanBeRemoved(boolean)

getReceiveKeyEventOnHidden

public boolean getReceiveKeyEventOnHidden()

See Also:

Overlay.getReceiveKeyEventOnHidden()

setReceiveKeyEventOnHidden

public void setReceiveKeyEventOnHidden(boolean value)

See Also:

Overlay.setReceiveKeyEventOnHidden(boolean)

getReceiveMouseEventOnHidden

public boolean getReceiveMouseEventOnHidden()

See Also:

Overlay.getReceiveMouseEventOnHidden()

setReceiveMouseEventOnHidden

public void setReceiveMouseEventOnHidden(boolean value)

See Also:

Overlay.setReceiveMouseEventOnHidden(boolean)

getAttachedROI

public ROI getAttachedROI()

Returns:

the attachedROI

isVisible

public boolean isVisible()

Returns:

the visible

setVisible

public void setVisible(boolean visible)

Parameters:

visible - the visible to set

getOpacity

public float getOpacity()

Returns:

the layer opacity

setOpacity

public void setOpacity(float value)

Set the layer opacity

getAlpha

@Deprecated
public float getAlpha()

Deprecated. Use getOpacity() instead

setAlpha

@Deprecated
public void setAlpha(float value)

Deprecated. Use setOpacity(float) instead.

addListener

public void addListener(Layer.LayerListener listener)

Add a listener

Parameters:

listener -

removeListener

public void removeListener(Layer.LayerListener listener)

Remove a listener

Parameters:

listener -

overlayChanged

public void overlayChanged(OverlayEvent event)

Specified by:

overlayChanged in interface OverlayListener

compareTo

public int compareTo(Layer layer)

Specified by:

compareTo in interface java.lang.Comparable<Layer>