Class GraphPort

java.lang.Object

com.codename1.graph.GraphPort

public class GraphPort
extends Object

A place on a GraphNode where edges attach, as in a node editor.

A node with no ports is connected node to node, as in a system diagram. Ports are ordered on their side of the node in the order they were added.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INPUT	The port takes incoming edges and sits on the leading side of the node.
static final int	OUTPUT	The port starts outgoing edges and sits on the trailing side.

Constructor Summary

Constructors

Constructor	Description
GraphPort(String id, int direction, String label, String type)	A port.

Method Summary

Modifier and Type	Method	Description
int	getDirection()	INPUT or OUTPUT.
String	getId()	The id, unique within the node.
String	getLabel()	The label, or null.
int	getMaxConnections()	How many edges may attach, or -1 for any number.
GraphNode	getNode()	The node the port belongs to, or null before it is added to one.
String	getType()	The data type edges must agree on, or null for any.
boolean	isInput()	True for an INPUT port.
void	setLabel(String label)	Sets the label.
void	setMaxConnections(int maxConnections)	Limits the edges that may attach; -1 for any number.
void	setType(String type)	Sets the data type.

Methods inherited from class Object

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

Field Details

INPUT

public static final int INPUT

The port takes incoming edges and sits on the leading side of the node.

See Also:

• Constant Field Values

OUTPUT

public static final int OUTPUT

The port starts outgoing edges and sits on the trailing side.

See Also:

• Constant Field Values

Constructor Details

GraphPort

public GraphPort(String id,
 int direction,
 String label,
 String type)

A port.

Parameters

• id: unique within its node
• direction: INPUT or OUTPUT
• label: painted beside the port, may be null
• type: compared by ConnectionValidator; null accepts any type

Method Details

getId

public String getId()

The id, unique within the node.

getDirection

public int getDirection()

INPUT or OUTPUT.

isInput

public boolean isInput()

True for an INPUT port.

getLabel

public String getLabel()

The label, or null.

setLabel

public void setLabel(String label)

Sets the label.

getType

public String getType()

The data type edges must agree on, or null for any.

setType

public void setType(String type)

Sets the data type.

getMaxConnections

public int getMaxConnections()

How many edges may attach, or -1 for any number.

setMaxConnections

public void setMaxConnections(int maxConnections)

Limits the edges that may attach; -1 for any number.

getNode

public GraphNode getNode()

The node the port belongs to, or null before it is added to one.