eu.mihosoft.vrl.workflow

Interface Connector

All Superinterfaces:

Model

All Known Subinterfaces:

ThruConnector

All Known Implementing Classes:

IOConnector, ThruConnectorImpl

public interface Connector
extends Model

This interface describes a connector. A connector is used to link nodes together. It serves as the input or output for the node. Methods allow you to detect whether the connector has been clicked or if it is used in a connection.

Author:

Michael Hoffer <info@michaelhoffer.de>

Property Summary

Type	Property and Description
ObjectProperty<Integer>	maxNumberOfConnections Returns the property of the maximum allowed number of connections.
ObjectProperty<ValueObject>	valueObject Returns the value object property (can be used to get notified if the value object changes).

Properties inherited from interface eu.mihosoft.vrl.workflow.Model

visualizationRequest

Method Summary

Modifier and Type	Method and Description
void	addClickEventListener(EventHandler<ClickEvent> handler) Adds the specified click-event listener to this connector.
void	addConnectionEventListener(EventHandler<ConnectionEvent> handler) Adds the specified connection-event listener to this connector.
void	click(MouseButton btn, Object event) Perform a mouse click on this connector.
String	getId() Returns the global id of this connector.
String	getLocalId() Returns the local id of this connector.
int	getMaxNumberOfConnections() Returns the maximum allowed number of connections.
VNode	getNode() Returns the parent node of this connector.
String	getType() Returns the conneciton type of this connector.
ValueObject	getValueObject() Returns the value object of this connector.
boolean	isInput() Determines whether this connector is an input connector.
boolean	isOutput() Determines whether this connector is an output connector.
ObjectProperty<Integer>	maxNumberOfConnectionsProperty() Returns the property of the maximum allowed number of connections.
void	removeClickEventListener(EventHandler<ClickEvent> handler) Removes the specified click-event listener from this connector.
void	removeConnectionEventListener(EventHandler<ConnectionEvent> handler) Removes the specified connection-event listener from this connector.
void	setLocalId(String id) Defines the local id of this connector.
void	setMaxNumberOfConnections(int numConnections) Defines the maximum allowed number of connections.
void	setValueObject(ValueObject obj) Defines the value object of this connector.
ObjectProperty<ValueObject>	valueObjectProperty() Returns the value object property (can be used to get notified if the value object changes).

Methods inherited from interface eu.mihosoft.vrl.workflow.Model

getVisualizationRequest, isVisualizationRequestInitialized, setVisualizationRequest, visualizationRequestProperty

Property Detail

valueObject

ObjectProperty<ValueObject> valueObjectProperty

Returns the value object property (can be used to get notified if the value object changes).

See Also:

getValueObject(), setValueObject(ValueObject)

maxNumberOfConnections

ObjectProperty<Integer> maxNumberOfConnectionsProperty

Returns the property of the maximum allowed number of connections.

See Also:

getMaxNumberOfConnections(), setMaxNumberOfConnections(int)

Method Detail

getType

String getType()

Returns the conneciton type of this connector.

Returns:

connection type (e.g. "control" or "data")

isInput

boolean isInput()

Determines whether this connector is an input connector.

Returns:

true if this connector is an input connector; false otherwise

isOutput

boolean isOutput()

Determines whether this connector is an output connector.

Returns:

true if this connector is an output connector; false otherwise

getId

String getId()

Returns the global id of this connector.

Returns:

global connector id

getLocalId

String getLocalId()

Returns the local id of this connector.

Returns:

local connector id

setLocalId

void setLocalId(String id)

Defines the local id of this connector.

Parameters:

id - the id to set

getNode

VNode getNode()

Returns the parent node of this connector.

Returns:

parent node of this connector

setValueObject

void setValueObject(ValueObject obj)

Defines the value object of this connector.

Parameters:

obj - value object to set

getValueObject

ValueObject getValueObject()

Returns the value object of this connector.

Returns:

value object or null if no value object has been defined

valueObjectProperty

ObjectProperty<ValueObject> valueObjectProperty()

Returns the value object property (can be used to get notified if the value object changes).

See Also:

getValueObject(), setValueObject(ValueObject)

addConnectionEventListener

void addConnectionEventListener(EventHandler<ConnectionEvent> handler)

Adds the specified connection-event listener to this connector.

Parameters:

handler - the listener to add

removeConnectionEventListener

void removeConnectionEventListener(EventHandler<ConnectionEvent> handler)

Removes the specified connection-event listener from this connector.

Parameters:

handler - the listener to remove

addClickEventListener

void addClickEventListener(EventHandler<ClickEvent> handler)

Adds the specified click-event listener to this connector.

Parameters:

handler - the listener to add

removeClickEventListener

void removeClickEventListener(EventHandler<ClickEvent> handler)

Removes the specified click-event listener from this connector.

Parameters:

handler - the listener to remove

click

void click(MouseButton btn,
           Object event)

Perform a mouse click on this connector.

Parameters:

btn - the click button

event - the event (e.g. javafx mouse-event)

setMaxNumberOfConnections

void setMaxNumberOfConnections(int numConnections)

Defines the maximum allowed number of connections.

Parameters:

numConnections - maximum allowed number of connections ([0,MAX_INT])

getMaxNumberOfConnections

int getMaxNumberOfConnections()

Returns the maximum allowed number of connections.

Returns:

maximum allowed number of connections ([0,MAX_INT])

maxNumberOfConnectionsProperty

ObjectProperty<Integer> maxNumberOfConnectionsProperty()

Returns the property of the maximum allowed number of connections.

See Also:

getMaxNumberOfConnections(), setMaxNumberOfConnections(int)