ptolemy.vergil.kernel.attributes
Class VisibleAttribute
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.util.Attribute
ptolemy.vergil.kernel.attributes.VisibleAttribute
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
- Direct Known Subclasses:
- AbstractTextAttribute, DocumentationAttribute, ImageAttribute, PDFAttribute, ShapeAttribute
public abstract class VisibleAttribute
- extends Attribute
Base class for attributes that are shown in vergil with their own icons.
This base class contains an attribute that results in its name being
hidden, and also handles commands to send it to the back or the front.
- Since:
- Ptolemy II 5.2
- Version:
- $Id: VisibleAttribute.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Edward A. Lee
- See Also:
- 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 |
VisibleAttribute(NamedObj container,
java.lang.String name)
Construct an attribute with the given name contained by the
specified container. |
Method Summary |
int |
moveToFirst()
Move this object to the first position in the list
of attributes of the container. |
int |
moveToLast()
Move this object to the last position in the list
of attributes of the container. |
Methods inherited from class ptolemy.kernel.util.Attribute |
_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToIndex, 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 |
VisibleAttribute
public VisibleAttribute(NamedObj container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Construct an attribute with the given name contained by the
specified container. The container argument must not be null, or a
NullPointerException will be thrown. This attribute will use the
workspace of the container for synchronization and version counts.
If the name argument is null, then the name is set to the empty
string. Increment the version of the workspace.
- Parameters:
container
- The container.name
- The name of this attribute.
- Throws:
IllegalActionException
- If the attribute is not of an
acceptable class for the container, or if the name contains a period.
NameDuplicationException
- If the name coincides with
an attribute already in the container.
moveToFirst
public int moveToFirst()
throws IllegalActionException
- Move this object to the first position in the list
of attributes of the container. This overrides the base
class to create an attribute named "_renderFirst" and to
remove an attribute named "_renderLast", if it is present.
This attribute is recognized by vergil, which then renders this
attribute before entities, connections, and other attributes.
This method gets write access on workspace
and increments the version.
- Specified by:
moveToFirst
in interface Moveable
- Overrides:
moveToFirst
in class Attribute
- Returns:
- The index of the specified object prior to moving it,
or -1 if it is not moved.
- Throws:
IllegalActionException
- If this object has
no container.
moveToLast
public int moveToLast()
throws IllegalActionException
- Move this object to the last position in the list
of attributes of the container. This overrides the base
class to create an attribute named "_renderLast" and to
remove an attribute named "_renderFirst" if it is present.
This attribute is recognized by vergil, which then renders this
attribute after entities, connections, and other attributes.
This method gets write access on workspace
and increments the version.
- Specified by:
moveToLast
in interface Moveable
- Overrides:
moveToLast
in class Attribute
- Returns:
- The index of the specified object prior to moving it,
or -1 if it is not moved.
- Throws:
IllegalActionException
- If this object has
no container.