Package com.piketec.tpt.api.diagram

Interface Transition

All Superinterfaces:

IdentifiableRemote, NamedObject, java.rmi.Remote, TptRemote

public interface Transition
extends NamedObject, IdentifiableRemote

This object represents the graphical transition between two DiagramNodes.

Method Summary

Modifier and Type	Method	Description
void	addAuxPoint(java.awt.Point p, int index)	Add a new list of auxiliary point for this transition.
TransitionSpec	createTransitionSpec(java.lang.String name, TransitionSpecGroup groupOrNull)	Create a new TransitionSpec.
TransitionSpecGroup	createTransitionSpecGroup(java.lang.String name, TransitionSpecGroup groupOrNull)	Create a new TransitionSpecGroup.
RemoteList<java.awt.Point>	getAuxPositions()	Returns a list of auxiliary points for this transition that are used to define a curvy shape instead of a straight line for this transition.
DiagramNode	getFrom()
DiagramNode	getTo()
RemoteList<TransitionSpecOrGroup>	getTopLevelTransitionSpecOrGroup()	Returns the list of transition specifications or specification groups directly assigned to this transition.
void	setFrom(DiagramNode n)	Set starting diagram node for this Transition
void	setTo(DiagramNode n)	Set end diagram node for this Transition

Methods inherited from interface com.piketec.tpt.api.IdentifiableRemote

getIdentifier

Methods inherited from interface com.piketec.tpt.api.NamedObject

getName, setName

Method Detail

getFrom

DiagramNode getFrom()
             throws java.rmi.RemoteException

Returns:

The starting diagram node of the Transition

Throws:

java.rmi.RemoteException - remote communication problem

getTo

DiagramNode getTo()
           throws java.rmi.RemoteException

Returns:

The end diagram node of the Transition

Throws:

java.rmi.RemoteException - remote communication problem

setFrom

void setFrom(DiagramNode n)
      throws java.rmi.RemoteException

Set starting diagram node for this Transition

Parameters:

n - The new starting point

Throws:

java.rmi.RemoteException - If n does not belong to the TPT instance represented by the API object.

setTo

void setTo(DiagramNode n)
    throws java.rmi.RemoteException

Set end diagram node for this Transition

Parameters:

n - The new end point

Throws:

java.rmi.RemoteException - If n does not belong to the TPT instance represented by the API object.

getAuxPositions

RemoteList<java.awt.Point> getAuxPositions()
                                    throws java.rmi.RemoteException

Returns a list of auxiliary points for this transition that are used to define a curvy shape instead of a straight line for this transition.

Returns:

List of auxiliary points

Throws:

java.rmi.RemoteException - remote communication problem

addAuxPoint

void addAuxPoint(java.awt.Point p,
                 int index)
          throws java.rmi.RemoteException

Add a new list of auxiliary point for this transition.

Parameters:

p - The new auxiliary point

index - The position of the new auxiliary point in the list.

Throws:

java.rmi.RemoteException - remote communication problem

getTopLevelTransitionSpecOrGroup

RemoteList<TransitionSpecOrGroup> getTopLevelTransitionSpecOrGroup()
                                                            throws java.rmi.RemoteException

Returns the list of transition specifications or specification groups directly assigned to this transition.

Since it can be either specifications or groups of specifications, it returns a list of TransitionSpecOrGroup that might represent a tree of specifications.

Returns:

The list of transition specifications or specification groups.

Throws:

java.rmi.RemoteException - remote communication problem

createTransitionSpec

TransitionSpec createTransitionSpec(java.lang.String name,
                                    TransitionSpecGroup groupOrNull)
                             throws java.rmi.RemoteException

Create a new TransitionSpec. The new specification is either added to a given group, or, if no group given, directly to the list of specifications for this transition.

Parameters:

name - The name for the new TransitionSpec

groupOrNull - The TransitionSpecGroup, where the newly created specification shall be added or null if it shall be directly added to the list of specifications of this transition.

Returns:

The newly created TransitionSpec.

Throws:

java.rmi.RemoteException - If groupOrNull does not belong to the TPT instance represented by the API object.

createTransitionSpecGroup

TransitionSpecGroup createTransitionSpecGroup(java.lang.String name,
                                              TransitionSpecGroup groupOrNull)
                                       throws java.rmi.RemoteException

Create a new TransitionSpecGroup. The new group is either added to a given group, or, if no group given, directly to the list of specifications for this transition.

Parameters:

name - The name for the new TransitionSpecGroup

groupOrNull - The TransitionSpecGroup, where the newly created specification shall be added or null if it shall be directly added to the list of specifications of this transition.

Returns:

The newly created TransitionSpecGroup.

Throws:

java.rmi.RemoteException - If groupOrNull does not belong to the TPT instance represented by the API object.