ptolemy.actor.gui.style
Class FileChooserStyle

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.util.Attribute
          extended byptolemy.actor.gui.style.ParameterEditorStyle
              extended byptolemy.actor.gui.style.FileChooserStyle
All Implemented Interfaces:
Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable

public class FileChooserStyle
extends ParameterEditorStyle

This attribute annotates user settable attributes to specify that the value of the parameter can be optionally given using a FileChooser.

Since:
Ptolemy II 2.0
Version:
$Id: FileChooserStyle.java,v 1.17.2.1 2004/06/18 00:48:53 cxh Exp $
Author:
Steve Neuendorffer and Edward A. Lee
See Also:
EditorPaneFactory, Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Yellow (eal)

Nested Class Summary
 
Nested classes 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, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Constructor Summary
FileChooserStyle()
          Construct an attribute in the default workspace with an empty string as its name.
FileChooserStyle(NamedObj container, java.lang.String name)
          Construct an attribute with the specified container and name.
FileChooserStyle(Workspace workspace)
          Construct an attribute in the given workspace with an empty string as its name.
 
Method Summary
 boolean acceptable(Settable param)
          Return true if this style is acceptable for the given parameter.
 void addEntry(PtolemyQuery query)
          Create a new entry in the given query associated with the attribute containing this style.
 
Methods inherited from class ptolemy.actor.gui.style.ParameterEditorStyle
setContainer
 
Methods inherited from class ptolemy.kernel.util.Attribute
_getContainedObject, _propagateExistence, clone, getContainer, setName
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, uniqueName, validateSettables, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FileChooserStyle

public FileChooserStyle()
Construct an attribute in the default workspace with an empty string as its name. The object is added to the directory of the workspace. Increment the version number of the workspace.


FileChooserStyle

public FileChooserStyle(Workspace workspace)
Construct an attribute in the given workspace with an empty string as its name. The object is added to the directory of the workspace. Increment the version number of the workspace.


FileChooserStyle

public FileChooserStyle(NamedObj container,
                        java.lang.String name)
                 throws IllegalActionException,
                        NameDuplicationException
Construct an attribute with the specified container and name.

Parameters:
container - The container.
name - The name of the attribute.
Throws:
IllegalActionException - If the attribute is not of an acceptable attribute for the container, or if the container is not an instance of Settable.
NameDuplicationException - If the name coincides with an attribute already in the container.
Method Detail

acceptable

public boolean acceptable(Settable param)
Return true if this style is acceptable for the given parameter.

Specified by:
acceptable in class ParameterEditorStyle
Parameters:
param - The attribute that this annotates.
Returns:
True if the argument is a StringAttribute, false otherwise.

addEntry

public void addEntry(PtolemyQuery query)
Create a new entry in the given query associated with the attribute containing this style. The name of the entry is the name of the attribute. Attach the attribute to the created entry.

Specified by:
addEntry in class ParameterEditorStyle
Parameters:
query - The query into which to add the entry.