ptolemy.actor.gui.style
Class TextStyle

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

All Implemented Interfaces:

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

public class TextStyle
extends ParameterEditorStyle

This attribute annotates user settable attributes to specify an arbitrary multi-line text area style for configuring the containing attribute. This style can be used with any Settable attribute.

Since:

Ptolemy II 2.1

Version:

$Id: TextStyle.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Zoltan Kemenczy, Research in Motion Ltd

See Also:

EditorPaneFactory, ParameterEditorStyle, Serialized Form

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (zkemenczy)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

Parameter	height The height (in lines) of the text box.
Parameter	width The width (in lines) of the text box.

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

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

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

Method Summary

private void	_initialize()
boolean	acceptable(Settable param) Return true if this style is acceptable for the given parameter.
void	addEntry(PtolemyQuery query) Create a new type-in line 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

Field Detail

height

public Parameter height

The height (in lines) of the text box. This is an integer that defaults to 10.

width

public Parameter width

The width (in lines) of the text box. This is an integer that defaults to 30.

Constructor Detail

TextStyle

public TextStyle()
          throws IllegalActionException,
                 NameDuplicationException

Construct an attribute in the default workspace with an empty string as its name. This constructor is for testing only. The object is added to the directory of the workspace. Increment the version number of the workspace.

Throws:

IllegalActionException - If the height or width attribute is not of an acceptable attribute for the container, or if the container is not an instance of Settable.

NameDuplicationException - If the height or width Parameter name coincides with an attribute already in the container.

TextStyle

public TextStyle(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 a new type-in line 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.

_initialize

private void _initialize()
                  throws IllegalActionException,
                         NameDuplicationException

Throws:

IllegalActionException

NameDuplicationException