ptolemy.vergil.basic
Class DocViewerFactory

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.actor.gui.EditorFactory
              ptolemy.vergil.basic.DocViewerFactory

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class DocViewerFactory
extends EditorFactory

An attribute that creates an editor to open a doc viewer for its container's container. The usage for this is to put it in a visible attribute. When the user double clicks on the visible attribute or selects Configure from the context menu, this class will open documentation for the container's container. If the container's container doesn't have any documentation, then the user sees a dialog with instructions on how to create the documentation.

Since:

Ptolemy II 5.2

Version:

$Id: DocViewerFactory.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Red (johnr)

Proposed Rating:

Red (eal)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

DocViewerFactory(NamedObj container, java.lang.String name)
Construct a factory with the specified container and name.

Method Summary

void	createEditor(NamedObj object, java.awt.Frame parent) Create a doc viewer for the specified object with the specified parent window.

Methods inherited from class ptolemy.actor.gui.EditorFactory

createEditor, createEditor

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocViewerFactory

public DocViewerFactory(NamedObj container,
                        java.lang.String name)
                 throws IllegalActionException,
                        NameDuplicationException

Construct a factory with the specified container and name.

Parameters:

container - The container.

name - The name of the factory.

Throws:

IllegalActionException - If the factory is not of an acceptable attribute for the container.

NameDuplicationException - If the name coincides with an attribute already in the container.

Method Detail

createEditor

public void createEditor(NamedObj object,
                         java.awt.Frame parent)

Create a doc viewer for the specified object with the specified parent window.

Specified by:

createEditor in class EditorFactory

Parameters:

object - The object to configure, which is required to an instance of DocAttribute.

parent - The parent window, which is required to be an instance of TableauFrame.