ptolemy.actor.gui.properties
Class Separator

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.actor.gui.properties.GUIProperty
              ptolemy.actor.gui.properties.Separator

All Implemented Interfaces:

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

public class Separator
extends GUIProperty

A GUI property that encloses a JSeparator component.

Since:

Ptolemy II 8.0

Version:

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

Author:

Thomas Huining Feng

See Also:

Serialized Form

Accepted Rating:

Red (tfeng)

Proposed Rating:

Red (tfeng)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

StringParameter

orientation The orientation of the JSeparator, which should be either "Horizontal" or "Vertical".

Fields inherited from class ptolemy.actor.gui.properties.GUIProperty

preferredSize

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

Separator(NamedObj container, java.lang.String name)
Construct a GUI property with the given name contained by the specified entity.

Separator(NamedObj container, java.lang.String name, javax.swing.JComponent component)
Construct a GUI property with the given name contained by the specified entity with the given Java Swing component.

Separator(NamedObj container, java.lang.String name, javax.swing.JComponent component, java.lang.Object constraint)
Construct a GUI property with the given name contained by the specified entity with the given Java Swing component and the given layout constraint.

Separator(NamedObj container, java.lang.String name, java.lang.Object constraint)
Construct a GUI property with the given name contained by the specified entity with the given layout constraint.

Method Summary

protected javax.swing.JComponent	_createComponent() Create a new JSeparator component.
private void	_init() Initialize this separator.
void	attributeChanged(Attribute attribute) React to a change in an attribute.

Methods inherited from class ptolemy.actor.gui.properties.GUIProperty

getComponent, 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, 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

orientation

public StringParameter orientation

The orientation of the JSeparator, which should be either "Horizontal" or "Vertical".

Constructor Detail

Separator

public Separator(NamedObj container,
                 java.lang.String name)
          throws IllegalActionException,
                 NameDuplicationException

Construct a GUI property with the given name contained by the specified entity. 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.

Separator

public Separator(NamedObj container,
                 java.lang.String name,
                 javax.swing.JComponent component)
          throws IllegalActionException,
                 NameDuplicationException

Construct a GUI property with the given name contained by the specified entity with the given Java Swing component. 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.

component - The Java Swing component.

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.

Separator

public Separator(NamedObj container,
                 java.lang.String name,
                 javax.swing.JComponent component,
                 java.lang.Object constraint)
          throws IllegalActionException,
                 NameDuplicationException

Construct a GUI property with the given name contained by the specified entity with the given Java Swing component and the given layout constraint. 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.

component - The Java Swing component.

constraint - The layout constraint.

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.

Separator

public Separator(NamedObj container,
                 java.lang.String name,
                 java.lang.Object constraint)
          throws IllegalActionException,
                 NameDuplicationException

Construct a GUI property with the given name contained by the specified entity with the given layout constraint. 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.

constraint - The layout constraint.

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.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute. This method is called by a contained attribute when its value changes. If the changed attribute is orientation, then the orientation of the JSeparator component in this GUI property is adjusted accordingly.

Overrides:

attributeChanged in class GUIProperty

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

_createComponent

protected javax.swing.JComponent _createComponent()
                                           throws IllegalActionException

Create a new JSeparator component.

Specified by:

_createComponent in class GUIProperty

Returns:

A Swing component that can be enclosed in this GUI property.

Throws:

IllegalActionException - Not thrown in this base class.

_init

private void _init()
            throws IllegalActionException,
                   NameDuplicationException

Initialize this separator.

Throws:

IllegalActionException - If the parameter is not of an acceptable class for the container.

NameDuplicationException - If the name coincides with a parameter already in the container.