ptolemy.vergil.actor
Class ActorController

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.ActorController
All Implemented Interfaces:
NodeController
Direct Known Subclasses:
ActorInstanceController, ClassDefinitionController

public abstract class ActorController
extends AttributeController

This class provides interaction with nodes that represent Ptolemy II entities. It provides a double click binding and context menu entry to edit the parameters of the node ("Configure"), a command to get documentation, and a command to look inside. 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 and to configure its ports. In addition, a layout algorithm is applied so that the figures for ports are automatically placed on the sides of the figure for the entity.

NOTE: This class is abstract because it is missing the code for laying out ports. Use the concrete subclasses ActorInstanceController or ClassDefinitionController instead.

Since:
Ptolemy II 2.0
Version:
$Id: ActorController.java,v 1.56.2.2 2004/07/19 04:43:53 cxh Exp $
Author:
Steve Neuendorffer and Edward A. Lee, Elaine Cheong
See Also:
ActorInstanceController, ClassDefinitionController
Accepted Rating:
Red (johnr)
Proposed Rating:
Red (eal)

Nested Class Summary
 class ActorController.EntityLayout
          This layout algorithm is responsible for laying out the ports within an entity.
static class ActorController.ListenToActorAction
          An action to listen to debug messages in the actor.
 
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
protected  AttributeController.Access _access
          The access level defined in the constructor.
protected  EditIconAction _editIconAction
          The action that handles edit custom icon.
protected  ptolemy.vergil.actor.ActorController.LookInsideAction _lookInsideAction
          The action that handles look inside.
protected  RemoveIconAction _removeIconAction
          The action that handles removing a custom icon.
 
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
ActorController(GraphController controller)
          Create an entity controller associated with the specified graph controller with full access.
ActorController(GraphController controller, AttributeController.Access access)
          Create an entity controller associated with the specified graph controller.
 
Method Summary
 void addMenuItemFactory(MenuItemFactory menuItemFactory)
          If access is FULL, then add the jni.ArgumentDailogFactory() to _menuFactory.
 void setConfiguration(Configuration configuration)
          Set the configuration.
 
Methods inherited from class ptolemy.vergil.basic.LocatableNodeController
_drawChildren, _hide, _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

_access

protected AttributeController.Access _access
The access level defined in the constructor.


_editIconAction

protected EditIconAction _editIconAction
The action that handles edit custom icon.


_lookInsideAction

protected ptolemy.vergil.actor.ActorController.LookInsideAction _lookInsideAction
The action that handles look inside. This is accessed by by ActorViewerController to create a hot key for the editor.


_removeIconAction

protected RemoveIconAction _removeIconAction
The action that handles removing a custom icon.

Constructor Detail

ActorController

public ActorController(GraphController controller)
Create an entity controller associated with the specified graph controller with full access.

Parameters:
controller - The associated graph controller.

ActorController

public ActorController(GraphController controller,
                       AttributeController.Access access)
Create an entity controller associated with the specified graph controller.

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

addMenuItemFactory

public void addMenuItemFactory(MenuItemFactory menuItemFactory)
If access is FULL, then add the jni.ArgumentDailogFactory() to _menuFactory. If access is not FULL, then do nothing.

Parameters:
menuItemFactory - The MenuItemFactory to be added.

setConfiguration

public void setConfiguration(Configuration configuration)
Set the configuration. This is used to open documentation files.

Overrides:
setConfiguration in class NamedObjController
Parameters:
configuration - The configuration.