Package ptolemy.vergil.basic.export.web

Class DefaultTitle

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.data.expr.Variable

ptolemy.data.expr.Parameter

ptolemy.data.expr.StringParameter

ptolemy.vergil.basic.export.web.WebContent

ptolemy.vergil.basic.export.web.DefaultTitle

All Implemented Interfaces:

java.lang.Cloneable, HasTypeConstraints, Typeable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable, ValueListener, WebExportable

public class DefaultTitle
extends WebContent
implements WebExportable

A parameter specifying default title to associate with a model and with components in the model. By default, this attribute uses the model name and component names as the title.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Edward A. Lee

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.data.expr.Variable

Variable.CircularDependencyError, Variable.VariableScope

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

NamedObj.ContainedObjectsIterator

Nested classes/interfaces inherited from interface ptolemy.kernel.util.Settable

Settable.Visibility

Field Summary

Fields

Modifier and Type	Field	Description
StringParameter	include	Specification of whether to provide the title for Attributes, Entities, or both.
StringParameter	instancesOf	If non-empty (the default), specifies a class name.
Parameter	showTitleInHTML	If set to true, then the title given by this parameter will be shown in the HTML prior to the image of the model (as well as in the image of the model, if it is visible when the export to web occurs).

Fields inherited from class ptolemy.vergil.basic.export.web.WebContent

_icon, displayText, height, width

Fields inherited from class ptolemy.data.expr.Variable

_currentExpression, _needsEvaluation, _parserScope, _parseTreeValid, _suppressVariableSubstitution, _valueListeners

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.kernel.util.Settable

EXPERT, FULL, NONE, NOT_EDITABLE

Constructor Summary

Constructors

Constructor	Description
DefaultTitle(NamedObj container, java.lang.String name)	Create an instance of this parameter.

Method Summary

Modifier and Type	Method	Description
protected void	_provideAttributes(WebExporter exporter)	Provide content to the specified web exporter to be included in a web page.
java.lang.String	getMimeType()	A title is of type text/html.
boolean	isOverwriteable()	Return true, since new title content should overwrite old title content.

Methods inherited from class ptolemy.vergil.basic.export.web.WebContent

_provideElements, attributeChanged, clone, provideContent

Methods inherited from class ptolemy.data.expr.StringParameter

stringValue

Methods inherited from class ptolemy.data.expr.Parameter

addChoice, exportMoML, getChoices, removeAllChoices, removeChoice

Methods inherited from class ptolemy.data.expr.Variable

_description, _evaluate, _getCurrentExpression, _notifyValueListeners, _parseIfNecessary, _propagate, _propagateToValueListeners, _propagateValue, _setToken, _setTokenAndNotify, addValueListener, getDeclaredType, getExpression, getFreeIdentifiers, getParserScope, getScope, getScope, getToken, getType, getTypeTerm, getValueAsString, getVariable, getVisibility, invalidate, isKnown, isLazy, isStringMode, isSuppressVariableSubstitution, isTypeAcceptable, removeValueListener, reset, setContainer, setExpression, setLazy, setName, setParseTreeEvaluator, setStringMode, setSuppressVariableSubstitution, setToken, setToken, setTypeAtLeast, setTypeAtLeast, setTypeAtMost, setTypeEquals, setTypeSameAs, setUnknown, setValueListenerAsWeakDependency, setVisibility, stringRepresentation, toString, typeConstraintList, typeConstraints, validate, valueChanged

Methods inherited from class ptolemy.kernel.util.AbstractSettableAttribute

getDefaultExpression

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, 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, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Settable

getDisplayName

Methods inherited from interface ptolemy.vergil.basic.export.web.WebExportable

provideContent

Field Detail

instancesOf

public StringParameter instancesOf

If non-empty (the default), specifies a class name. Only entities or attributes (depending on include) implementing the specified class will be assigned the title defined by this DefaultTitle parameter.

include

public StringParameter include

Specification of whether to provide the title for Attributes, Entities, or both. This is either "Entities" (the default), "Attributes", "All", or "None".

showTitleInHTML

public Parameter showTitleInHTML

If set to true, then the title given by this parameter will be shown in the HTML prior to the image of the model (as well as in the image of the model, if it is visible when the export to web occurs). This is a boolean that defaults to true.

Constructor Detail

DefaultTitle

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

Create an instance of this parameter.

Parameters:

container - The container.

name - The name.

Throws:

IllegalActionException - If the superclass throws it.

NameDuplicationException - If the superclass throws it.

Method Detail

getMimeType

public java.lang.String getMimeType()

A title is of type text/html.

Specified by:

getMimeType in interface WebExportable

Returns:

The string text/html

isOverwriteable

public boolean isOverwriteable()

Return true, since new title content should overwrite old title content.

Specified by:

isOverwriteable in interface WebExportable

Returns:

True, since new title content should overwrite old title content.

_provideAttributes

protected void _provideAttributes(WebExporter exporter)
                           throws IllegalActionException

Provide content to the specified web exporter to be included in a web page. This class provides a default title for the web page and for each object as specified by include and instancesOf.

Overrides:

_provideAttributes in class WebContent

Parameters:

exporter - The web exporter to which to write content.

Throws:

IllegalActionException - If something is wrong with the web content or the object already has an attribute with the same name as the the created WebAttribute