ptolemy.vergil.actor
Class ExternalIOPortController

java.lang.Object
  extended bydiva.graph.BasicNodeController
      extended byptolemy.vergil.basic.LocatableNodeController
          extended byptolemy.vergil.basic.NamedObjController
              extended byptolemy.vergil.basic.ParameterizedNodeController
                  extended byptolemy.vergil.basic.IconController
                      extended byptolemy.vergil.kernel.AttributeController
                          extended byptolemy.vergil.actor.ExternalIOPortController
All Implemented Interfaces:
NodeController

public class ExternalIOPortController
extends AttributeController

This class provides interaction with nodes that represent Ptolemy II ports inside a composite. It provides a double click binding and context menu entry to edit the parameters of the port ("Configure") and a command to get documentation. It can have one of two access levels, FULL or PARTIAL. If the access level is FULL, the the context menu also contains a command to rename the node. Note that whether the port is an input or output or multiport cannot be controlled via this interface. The "Configure Ports" command of the container should be invoked instead.

Since:
Ptolemy II 2.0
Version:
$Id: ExternalIOPortController.java,v 1.26 2004/05/01 16:18:26 eal Exp $
Author:
Steve Neuendorffer and Edward A. Lee
Accepted Rating:
Red (johnr)
Proposed Rating:
Red (eal)

Nested Class Summary
 class ExternalIOPortController.PortRenderer
          Render the external ports of a graph as a 5-sided tab thingy.
 
Nested classes inherited from class ptolemy.vergil.kernel.AttributeController
AttributeController.Access
 
Nested classes inherited from class ptolemy.vergil.basic.IconController
IconController.IconRenderer
 
Nested classes inherited from class ptolemy.vergil.basic.NamedObjController
NamedObjController.GetDocumentationAction
 
Field Summary
static IOPort _GENERIC_INOUT
           
static IOPort _GENERIC_INOUT_MULTIPORT
           
static IOPort _GENERIC_INPUT
           
static IOPort _GENERIC_INPUT_MULTIPORT
           
static IOPort _GENERIC_OUTPUT
           
static IOPort _GENERIC_OUTPUT_MULTIPORT
           
 
Fields inherited from class ptolemy.vergil.kernel.AttributeController
FULL, PARTIAL
 
Fields inherited from class ptolemy.vergil.basic.ParameterizedNodeController
_configureAction, _menuCreator, _menuFactory
 
Fields inherited from class ptolemy.vergil.basic.NamedObjController
_configuration
 
Fields inherited from class ptolemy.vergil.basic.LocatableNodeController
CLASS_ELEMENT_HIGHLIGHT_COLOR
 
Constructor Summary
ExternalIOPortController(GraphController controller)
          Create a port controller associated with the specified graph controller.
ExternalIOPortController(GraphController controller, AttributeController.Access access)
          Create a port controller associated with the specified graph controller.
 
Method Summary
protected  boolean _hide(java.lang.Object node)
          Override the base class to return true if the specified node contains an attribute named "_hideInside".
 
Methods inherited from class ptolemy.vergil.basic.NamedObjController
setConfiguration
 
Methods inherited from class ptolemy.vergil.basic.LocatableNodeController
_drawChildren, _renderNode, addNode, drawNode, getLocation, hasLocation, locateFigure, setLocation, setSnapResolution
 
Methods inherited from class diva.graph.BasicNodeController
addNode, addNode, addNode, clearNode, drawNode, getController, getNodeInteractor, getNodeRenderer, removeNode, setNodeInteractor, setNodeRenderer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_GENERIC_INPUT

public static IOPort _GENERIC_INPUT

_GENERIC_OUTPUT

public static IOPort _GENERIC_OUTPUT

_GENERIC_INOUT

public static IOPort _GENERIC_INOUT

_GENERIC_INPUT_MULTIPORT

public static IOPort _GENERIC_INPUT_MULTIPORT

_GENERIC_OUTPUT_MULTIPORT

public static IOPort _GENERIC_OUTPUT_MULTIPORT

_GENERIC_INOUT_MULTIPORT

public static IOPort _GENERIC_INOUT_MULTIPORT
Constructor Detail

ExternalIOPortController

public ExternalIOPortController(GraphController controller)
Create a port controller associated with the specified graph controller. The controller is given full access.

Parameters:
controller - The associated graph controller.

ExternalIOPortController

public ExternalIOPortController(GraphController controller,
                                AttributeController.Access access)
Create a port controller associated with the specified graph controller.

Parameters:
controller - The associated graph controller.
access - The access level.
Method Detail

_hide

protected boolean _hide(java.lang.Object node)
Override the base class to return true if the specified node contains an attribute named "_hideInside". This ensures that ports can be hidden on the outside while still being visible on the outside.

Overrides:
_hide in class LocatableNodeController