ptolemy.vergil.basic
Class NamedObjController

java.lang.Object
  extended bydiva.graph.BasicNodeController
      extended byptolemy.vergil.basic.LocatableNodeController
          extended byptolemy.vergil.basic.NamedObjController
All Implemented Interfaces:
NodeController
Direct Known Subclasses:
ParameterizedNodeController

public class NamedObjController
extends LocatableNodeController

This class extends LocatableNodeController with an association with a configuration. The configuration is central to a Ptolemy GUI, and is used by derived classes to perform various functions such as opening models or their documentation. The class also contains an inner class the specifically supports accessing the documentation for a Ptolemy II object.

Since:
Ptolemy II 2.0
Version:
$Id: NamedObjController.java,v 1.18 2004/04/13 03:49:48 cxh Exp $
Author:
Edward A. Lee
Accepted Rating:
Red (johnr)
Proposed Rating:
Red (eal)

Nested Class Summary
protected  class NamedObjController.GetDocumentationAction
          This is an action that accesses the documentation for a Ptolemy object associated with a figure.
 
Field Summary
protected  Configuration _configuration
          The configuration.
 
Fields inherited from class ptolemy.vergil.basic.LocatableNodeController
CLASS_ELEMENT_HIGHLIGHT_COLOR
 
Constructor Summary
NamedObjController(GraphController controller)
          Create a node controller associated with the specified graph controller.
 
Method Summary
 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

_configuration

protected Configuration _configuration
The configuration.

Constructor Detail

NamedObjController

public NamedObjController(GraphController controller)
Create a node controller associated with the specified graph controller.

Parameters:
controller - The associated graph controller.
Method Detail

setConfiguration

public void setConfiguration(Configuration configuration)
Set the configuration. This is used in derived classes to to open files (such as documentation). The configuration is is important because it keeps track of which files are already open and ensures that there is only one editor operating on the file at any one time.

Parameters:
configuration - The configuration.