ptolemy.actor.gui.style
Class HiddenStyle

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.actor.gui.style.ParameterEditorStyle
              ptolemy.actor.gui.style.HiddenStyle

All Implemented Interfaces:

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

public class HiddenStyle
extends ParameterEditorStyle

This attribute annotates user settable attributes to specify a version of the line style which is invisible. This style can be used with any Settable attribute.

Since:

Ptolemy II 8.0

Version:

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

Author:

Man-Kit Leung

See Also:

EditorPaneFactory, ParameterEditorStyle, LineStyle, Serialized Form

Accepted Rating:

Red (mankit)

Proposed Rating:

Red (mankit)

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

HiddenStyle()
Construct an attribute in the default workspace with an empty string as its name.

HiddenStyle(NamedObj container, java.lang.String name)
Construct an attribute with the specified container and name.

HiddenStyle(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 no 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

_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

Constructor Detail

HiddenStyle

public HiddenStyle()

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.

HiddenStyle

public HiddenStyle(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.

HiddenStyle

public HiddenStyle(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.

addEntry

public void addEntry(PtolemyQuery query)

Create no entry in the given query associated with the attribute containing this style.

Specified by:

addEntry in class ParameterEditorStyle

Parameters:

query - The given query.