Package ptolemy.vergil.actor

Class ActorController

  • All Implemented Interfaces:
    NodeController
    Direct Known Subclasses:
    ActorInstanceController, ClassDefinitionController, MatchResultViewer.MatchResultActorController, TransformationEditor.TransformationActorController
    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 open an actor. 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$
    Author:
    Steve Neuendorffer and Edward A. Lee, Elaine Cheong, Contributor: Sven Koehler
    See Also:
    ActorInstanceController, ClassDefinitionController
    Pt.AcceptedRating:
    Red (johnr)
    Pt.ProposedRating:
    Red (eal)

    • Field Detail

      • _editIconAction

        protected EditIconAction _editIconAction
        The action that handles edit custom icon.

      • _flipPortsHorizontal

        protected RotateOrFlipPorts _flipPortsHorizontal
        An action that handles flipping the ports horizontally.

      • _flipPortsVertical

        protected RotateOrFlipPorts _flipPortsVertical
        An action that handles flipping the ports vertically.

      • _lookInsideAction

        protected LookInsideAction _lookInsideAction
        The action that handles opening an actor. This is accessed by by ActorViewerController to create a hot key for the editor. The name "lookInside" is historical and preserved to keep backward compatibility with subclasses.

      • _openInstanceAction

        protected ptolemy.vergil.actor.ActorController.OpenInstanceAction _openInstanceAction
        The action that handles opening an instance.

      • _removeIconAction

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

      • _rotatePortsClockwise

        protected RotateOrFlipPorts _rotatePortsClockwise
        An action that handles rotating the ports by 90 degrees.

      • _rotatePortsCounterclockwise

        protected RotateOrFlipPorts _rotatePortsCounterclockwise
        An action that handles rotating the ports by 90 degrees.

    • 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.

      • addHotKeys

        public void addHotKeys​(JGraph jgraph)
        Add hot keys to the actions in the given JGraph. It would be better that this method was added higher in the hierarchy. Now most controllers
        Overrides:
        addHotKeys in class AttributeController
        Parameters:
        jgraph - The JGraph to which hot keys are to be added.

      • setConfiguration

        public void setConfiguration​(Configuration configuration)
        Set the configuration. This is used to open documentation files.
        Overrides:
        setConfiguration in class AttributeController
        Parameters:
        configuration - The configuration.

      • _getComponentType

        protected java.lang.String _getComponentType()
        Get the class label of the component.
        Overrides:
        _getComponentType in class AttributeController
        Returns:
        the class label of the component.