NamedObjController

java.lang.Object
- diva.graph.BasicNodeController
- - ptolemy.vergil.basic.LocatableNodeController
  - - ptolemy.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$

Author:

Edward A. Lee

Pt.AcceptedRating:

Red (johnr)

Pt.ProposedRating:

Red (eal)

Field Summary

Fields
Modifier and Type Field Description

protected Configuration _configuration
The configuration.
- Fields inherited from class ptolemy.vergil.basic.LocatableNodeController
  _decoratable, CLASS_ELEMENT_HIGHLIGHT_COLOR

Constructor Summary

Constructors
Constructor Description

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addHotKeys(JGraph jgraph)`	Add hot keys to the actions in the given JGraph.
`void`	`setConfiguration(Configuration configuration)`	Set the configuration.

Methods inherited from class ptolemy.vergil.basic.LocatableNodeController
_drawChildren, _getCompositeFigure, _hide, _isPropertySet, _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
  - 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
    
    Parameters:
    
    jgraph - The JGraph to which hot keys are to be added.
  - 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.