ptolemy.vergil.toolbox
Class ArrayOfRecordsConfigureFactory

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.actor.gui.EditorFactory
              ptolemy.vergil.toolbox.ArrayOfRecordsConfigureFactory

All Implemented Interfaces:

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

public class ArrayOfRecordsConfigureFactory
extends EditorFactory

If this class is contained by an actor, then double clicking on that actor will display a table that shows the value of an array of tokens contained by a parameter contained by the same container as this factory. The name of the parameter is given by the parameterName attribute of this factory. It is required that the parameter contain an array of records.

Since:

Ptolemy II 8.0

Version:

$Id: ArrayOfRecordsConfigureFactory.java 57044 2010-01-27 22:41:05Z cxh $

Author:

Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Red (ptolemy)

Proposed Rating:

Yellow (eal)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

Parameter	columns The names of the fields to be displayed from the records, in the order in which they should be displayed.
StringParameter	parameterName The name of the attribute that is to be displayed.

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

ArrayOfRecordsConfigureFactory(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 top-level 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

Field Detail

columns

public Parameter columns

The names of the fields to be displayed from the records, in the order in which they should be displayed. This is required to be an array of string tokens. This defaults to null (no value) which results in all fields being displayed in alphabetical order.

parameterName

public StringParameter parameterName

The name of the attribute that is to be displayed. That attribute is required to contain an array of record tokens.

Constructor Detail

ArrayOfRecordsConfigureFactory

public ArrayOfRecordsConfigureFactory(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 top-level 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 contain a parameter with name matching parameterName and value that is an array of records.

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