ptolemy.vergil.kernel.attributes
Class DocumentationAttribute.DocumentationAttributeFactory

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.actor.gui.EditorFactory
              ptolemy.vergil.kernel.attributes.DocumentationAttribute.DocumentationAttributeFactory

All Implemented Interfaces:

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

Enclosing class:

DocumentationAttribute

private static class DocumentationAttribute.DocumentationAttributeFactory
extends EditorFactory

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

DocumentationAttribute.DocumentationAttributeFactory(NamedObj _container, java.lang.String name)

Method Summary

void	createEditor(NamedObj object, java.awt.Frame parent) Display the documentation if there is any.

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

DocumentationAttribute.DocumentationAttributeFactory

public DocumentationAttribute.DocumentationAttributeFactory(NamedObj _container,
                                                            java.lang.String name)
                                                     throws IllegalActionException,
                                                            NameDuplicationException

Throws:

IllegalActionException

NameDuplicationException

Method Detail

createEditor

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

Display the documentation if there is any. If not, offer a dialog to let the user specify where the documentation is located.

Specified by:

createEditor in class EditorFactory

Parameters:

object - The object to configure.

parent - The parent window, or null if there is none.