Package pamViewFX.fxNodes.connectionPane
Interface ConnectionNode
- All Known Implementing Classes:
 BinaryConnectionNode,ConnectionGroupStructure,DBConnectionNode,DisplayConnectionNode,ExtensionSocketStructure,ModuleConnectionNode,PamExtensionStructure,PamGroupStructure,StandardConnectionNode
public interface ConnectionNode
A connection node is a node that has a parent and children
- Author:
 - Jamie Macaulay
 
- 
Method Summary
Modifier and TypeMethodDescriptionvoidaddConnectionListener(ConnectionListener connectListener) Add a connection listener.voidaddConnectorNodeListener(ConnectorNodeListener connectorNodeListenr) Add a connector node listener.ArrayList<? extends ConnectorNode> Get any branch sockets- these are inputs connection to the primary socket.ArrayList<? extends ConnectionNode> Get children of the connection nodejavafx.scene.GroupGet the group that holds all components of the ConnectionNode e.g.javafx.scene.NodeGet the main connection body.ArrayList<? extends ConnectorNode> Get connection plugs.ArrayList<? extends ConnectorNode> Get connection sockets for a node.ArrayList<? extends ConnectionNode> Get the parents of this connection nodeArrayList<? extends ConnectionLine> Get the lines that connect plugs and the connection node.voidnotifyChange(int flag, StandardConnectionNode connectionNode) Notify the connection node of a general change.voidnotifyConnectionListeners(ConnectorNode connectedShape, ConnectorNode plugShape, int connected) Notify all connection listener in the node.voidremoveConnectionListener(ConnectionListener connectListener) Remove a connection listeners.voidremoveConnectorNodeListener(ConnectorNodeListener connectorNodeListenr) Remove a connector node listener. 
- 
Method Details
- 
getParentConnectionNodes
ArrayList<? extends ConnectionNode> getParentConnectionNodes()Get the parents of this connection node- Returns:
 - the parents of this connection node.
 
 - 
getChildConnectionNodes
ArrayList<? extends ConnectionNode> getChildConnectionNodes()Get children of the connection node- Returns:
 - a list of the children connected to to the node.
 
 - 
getConnectionSockets
ArrayList<? extends ConnectorNode> getConnectionSockets()Get connection sockets for a node. Connection sockets are connections that accept a parent node.- Returns:
 - a list of the connection sockets.
 
 - 
getConnectionPlugs
ArrayList<? extends ConnectorNode> getConnectionPlugs()Get connection plugs. Connection plugs are connections that can be connected to a child.- Returns:
 - a list of the connection plugs.
 
 - 
getPlugConnectionLines
ArrayList<? extends ConnectionLine> getPlugConnectionLines()Get the lines that connect plugs and the connection node.- Returns:
 - all lines connecting plugs and connection nodes.
 
 - 
getBranchConnectionSockets
ArrayList<? extends ConnectorNode> getBranchConnectionSockets()Get any branch sockets- these are inputs connection to the primary socket.- Returns:
 - branch sockets
 
 - 
getConnectionNodeBody
javafx.scene.Node getConnectionNodeBody()Get the main connection body. This is the node that can be dragged etc.- Returns:
 - the main connection node body.
 
 - 
getConnectionGroup
javafx.scene.Group getConnectionGroup()Get the group that holds all components of the ConnectionNode e.g. the body, plugs etc.- Returns:
 - the connection node group.
 
 - 
notifyChange
Notify the connection node of a general change.- Parameters:
 flag- - the change flag.connectionNode- - the connection node
 - 
addConnectorNodeListener
Add a connector node listener. This listens for any events from connector nodes attached to the connection node.- Parameters:
 connectorNodeListener- - the connector node listener to add.
 - 
removeConnectorNodeListener
Remove a connector node listener. This listens for any events from connector nodes attached to the connection node.- Parameters:
 connectorNodeListener- - the connector node listener to remove.
 - 
notifyConnectionListeners
void notifyConnectionListeners(ConnectorNode connectedShape, ConnectorNode plugShape, int connected) Notify all connection listener in the node.- Parameters:
 connectedShape-plugShape-connected-
 - 
addConnectionListener
Add a connection listener. This listens for other connection nodes which have connected- Parameters:
 connectListener- - the connection listener to add.
 - 
removeConnectionListener
Remove a connection listeners. This listens for other connection nodes which have connected- Parameters:
 connectListener- - the connection listener to remove.
 
 -