ptolemy.actor.gui.style
Class FileChooserStyle
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.util.Attribute
ptolemy.actor.gui.style.ParameterEditorStyle
ptolemy.actor.gui.style.FileChooserStyle
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
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 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Steve Neuendorffer and Edward A. Lee
- See Also:
EditorPaneFactory
,
Serialized Form
- Accepted Rating:
- Proposed Rating:
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 |
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.kernel.util.Attribute |
_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, 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 |
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.
- Parameters:
workspace
- The workspace that will contain the attribute
that is being constructed.
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.
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)
throws IllegalActionException
- 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.
- Throws:
IllegalActionException
- If thrown when accessing parameters
specifying whether files or directories should be listed.