org.eclipse.eavp.viz.service.javafx.scene.base

Class GNode

java.lang.Object

org.eclipse.eavp.viz.service.javafx.scene.base.GNode

All Implemented Interfaces:

INode

public final class GNode
extends java.lang.Object
implements INode

INode model implementation. This class is not meant to be extended, either implement new functionality via the INode interface or with attachments via IAttachment.

Author:

Tony McCrary (tmccrary@l33tlabs.com)

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.service.javafx.scene.model.INode

RENDERER_NODE_PROP

Constructor Summary

Constructors

Constructor and Description
GNode()

Method Summary

Modifier and Type	Method and Description
void	addChild(INode node) Adds a node to this node as a child node.
void	attach(IAttachment attachment) Adds the supplied attachment to this node.
void	detach(IAttachment attachment) Removes the supplied attachment to this node.
java.util.Map<java.lang.Class<?>,java.util.List<IAttachment>>	getAttachments() Returns a Map of all the node's attachments.
java.util.List<IAttachment>	getAttachments(java.lang.Class<?> clazz) Returns a List of the node's attachments that are of the supplied type.
java.util.List<INode>	getChildren(boolean copy) Returns a List of this node's children, optionally returning a copy of the List.
java.lang.String	getName() Returns the human readable name of the node.
INode	getParent() Returns the parent of the node, or null if the node is not associated with a parent.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Returns a Map of the node's current properties.
java.lang.Object	getProperty(java.lang.String key) Returns the node property of the specified type or null if the property doesn't exist.
boolean	hasAttachment(java.lang.Class<?> attachmentClazz) Returns true if this node has an attachment of the supplied class type.
boolean	hasProperty(java.lang.String key) Returns true if the property has been set on this object, false otherwise.
boolean	isVisible() Returns if the node is visible.
void	removeAllChildren() Removes all children from this node.
void	removeChild(INode node) Removes the supplied node as a child from this node.
void	setName(java.lang.String name)
void	setParent(INode parent) Sets the parent of the node.
void	setProperty(java.lang.String key, java.lang.Object value) Sets the property identified by the key String to the supplied value.
void	setVisible(boolean visible) Sets the visibility of the node.
boolean	supports(IAttachment attachment) Returns true if the node supports the supplied attachment.

Methods inherited from class java.lang.Object

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

Constructor Detail

GNode

public GNode()

Method Detail

addChild

public void addChild(INode node)

Description copied from interface: INode

Adds a node to this node as a child node. Once the child has been added, the child node will be linked to the parent for transforms and other operations.

Specified by:

addChild in interface INode

Parameters:

node - node to add as child

removeChild

public void removeChild(INode node)

Description copied from interface: INode

Removes the supplied node as a child from this node. If node is not currently a child, this is a no-op.

Specified by:

removeChild in interface INode

Parameters:

node - node to remove as child

removeAllChildren

public void removeAllChildren()

Description copied from interface: INode

Removes all children from this node.

Specified by:

removeAllChildren in interface INode

getChildren

public java.util.List<INode> getChildren(boolean copy)

Description copied from interface: INode

Returns a List of this node's children, optionally returning a copy of the List.

Specified by:

getChildren in interface INode

Returns:

copy if true, the list will be a copy of the node's internal List. if false, the list will be a reference to the internal List.

attach

public void attach(IAttachment attachment)

Description copied from interface: INode

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

Specified by:

attach in interface INode

Parameters:

attachment - the attachment to attach

detach

public void detach(IAttachment attachment)

Description copied from interface: INode

Removes the supplied attachment to this node. The attachment's functionality with be removed from this node.

If the attachment is not currently attached, this is a no-op.

Specified by:

detach in interface INode

Parameters:

attachment - the attachment to remove.

hasAttachment

public boolean hasAttachment(java.lang.Class<?> attachmentClazz)

Description copied from interface: INode

Returns true if this node has an attachment of the supplied class type.

Specified by:

hasAttachment in interface INode

Parameters:

attachmentClazz - the attachment class to check for.

Returns:

true if the attachment type exists in this node, false otherwise.

supports

public boolean supports(IAttachment attachment)

Description copied from interface: INode

Returns true if the node supports the supplied attachment. Some attachments may not be used together.

Specified by:

supports in interface INode

Parameters:

attachment - the attachment to check for

Returns:

true if the node supports the attachment, false otherwise

getAttachments

public java.util.Map<java.lang.Class<?>,java.util.List<IAttachment>> getAttachments()

Description copied from interface: INode

Returns a Map of all the node's attachments.

Specified by:

getAttachments in interface INode

Returns:

a Map of the node's current attachments

getAttachments

public java.util.List<IAttachment> getAttachments(java.lang.Class<?> clazz)

Description copied from interface: INode

Returns a List of the node's attachments that are of the supplied type.

Specified by:

getAttachments in interface INode

Parameters:

clazz - the attachment class type to retrieve

Returns:

a List of the node's attachments of the specified type.

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Description copied from interface: INode

Returns a Map of the node's current properties.

Specified by:

getProperties in interface INode

Returns:

a Map of the node's current properties.

getProperty

public java.lang.Object getProperty(java.lang.String key)

Description copied from interface: INode

Returns the node property of the specified type or null if the property doesn't exist.

Specified by:

getProperty in interface INode

Returns:

the node property of the specified type or null if the property doesn't exist

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Description copied from interface: INode

Sets the property identified by the key String to the supplied value.

Specified by:

setProperty in interface INode

Parameters:

key - the String identifier of the property

value - the value of the property

hasProperty

public boolean hasProperty(java.lang.String key)

Description copied from interface: INode

Returns true if the property has been set on this object, false otherwise.

Specified by:

hasProperty in interface INode

Parameters:

key - the property key to check for

Returns:

true if the property exists, false otherwise

isVisible

public boolean isVisible()

Description copied from interface: INode

Returns if the node is visible.

Specified by:

isVisible in interface INode

Returns:

true if the node is visible, false otherwise.

setVisible

public void setVisible(boolean visible)

Description copied from interface: INode

Sets the visibility of the node. If the node is not visible, it will not show up in a viewport.

Specified by:

setVisible in interface INode

Parameters:

visible - if true, the node will be rendered in visualizations. if false, the node will not be rendered.

getParent

public INode getParent()

Description copied from interface: INode

Returns the parent of the node, or null if the node is not associated with a parent.

Specified by:

getParent in interface INode

Returns:

setParent

public void setParent(INode parent)

Description copied from interface: INode

Sets the parent of the node.

Specified by:

setParent in interface INode

Parameters:

parent - the parent of the node to set

setName

public void setName(java.lang.String name)

Parameters:

name -

getName

public java.lang.String getName()

Description copied from interface: INode

Returns the human readable name of the node.

Specified by:

getName in interface INode

Returns:

a String containing the human readable name of the node.