org.eclipse.eavp.viz.service.javafx.canvas

Class Attachment

java.lang.Object

org.eclipse.eavp.viz.service.javafx.canvas.Attachment

All Implemented Interfaces:

IAttachment

Direct Known Subclasses:

BasicAttachment, CameraAttachment, GeometryAttachment

public abstract class Attachment
extends java.lang.Object
implements IAttachment

Base for IAttachment implementations.

Author:

Tony McCrary (tmccrary@l33tlabs.com)

Constructor Summary

Constructors

Constructor and Description
Attachment()

Method Summary

Modifier and Type	Method and Description
void	attach(INode owner) Adds this instance to the supplied node.
void	detach(INode owner) Removes this instance from the supplied node.
INode	getOwner() Returns the node this attachment is attached to or null if there is no attached node.
boolean	isSingleton() If the attachment is a singleton, only a single instance of the attachment can be attached to any given node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.eavp.viz.service.javafx.scene.model.IAttachment

getType

Constructor Detail

Attachment

public Attachment()

Method Detail

getOwner

public INode getOwner()

Description copied from interface: IAttachment

Returns the node this attachment is attached to or null if there is no attached node.

Specified by:

getOwner in interface IAttachment

Returns:

the INode currently attached or null if a node has not been attached.

See Also:

IAttachment.getOwner()

attach

public void attach(INode owner)

Description copied from interface: IAttachment

Adds this instance to the supplied node. The attachment's functionality will be applied to the new owner node.

If the attachment is a singleton, this will replace any existing attachment of the same type.

Specified by:

attach in interface IAttachment

Parameters:

owner - the node to attach to

See Also:

IAttachment.attach(INode)

detach

public void detach(INode owner)

Description copied from interface: IAttachment

Removes this instance from the supplied node. Any functionality provided by this attachment will be removed from the owner node.

If the supplied node is not attached, this is a no-op.

Specified by:

detach in interface IAttachment

Parameters:

owner - the node to detach from

See Also:

IAttachment.detach(INode)

isSingleton

public boolean isSingleton()

Description copied from interface: IAttachment

If the attachment is a singleton, only a single instance of the attachment can be attached to any given node.

Specified by:

isSingleton in interface IAttachment

Returns:

true if the attachment type is a singleton, false otherwise.

See Also:

IAttachment.isSingleton()