Package ptolemy.vergil.toolbox

Class AnnotationEditorFactory

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.actor.gui.EditorFactory

ptolemy.vergil.toolbox.AnnotationEditorFactory

All Implemented Interfaces:

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

@Deprecated
public class AnnotationEditorFactory
extends EditorFactory

Deprecated.

Use ptolemy.vergil.kernel.attributes.TextAttribute.

If this class is contained by a visible attribute (one that has an attribute called "_iconDescription"), then double clicking on that attribute will invoke an editor for a textual annotation. This class is contained by visible attribute in the Vergil utilities library, which provides a facility for adding visual annotations to diagrams.

Since:

Ptolemy II 2.0

Version:

$Id$

Author:

Edward A. Lee

Pt.AcceptedRating:

Red (johnr)

Pt.ProposedRating:

Red (eal)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AnnotationEditorFactory.AnnotationTextEditor	Deprecated. A text widget for editing textual annotations (which are visible attributes).

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, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

Constructors

Constructor	Description
AnnotationEditorFactory(NamedObj container, java.lang.String name)	Deprecated. Construct a factory with the specified container and name.

Method Summary

Modifier and Type	Method	Description
void	createEditor(NamedObj object, java.awt.Frame parent)	Deprecated. Create an editor for configuring the specified object.
java.awt.Component	createEditorPane()	Deprecated. Return a new widget for configuring the container.

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, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, 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, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, 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

AnnotationEditorFactory

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

Deprecated.

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)

Deprecated.

Create an editor for configuring the specified object.

Specified by:

createEditor in interface Editable

Specified by:

createEditor in class EditorFactory

Parameters:

object - The object to configure.

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

createEditorPane

public java.awt.Component createEditorPane()

Deprecated.

Return a new widget for configuring the container.

Returns:

A JPanel that is a text editor for editing the annotation text.