Package ptolemy.vergil.basic.export.web

Class WebContent

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultTitle, HTMLImage, HTMLText, IconLink, JSPlotterAttribute, Script

public abstract class WebContent
extends StringParameter
implements WebExportable

Base class for attributes defining content for export to web. This class provides parameters that control the size of the text box for editing the content and also a parameter that defines what to display in the model.

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
protected TextIcon	_icon	Icon.
StringParameter	displayText	Parameter giving the text to display in the Ptolemy model.
Parameter	height	Parameter specifying the height of the editing box.
Parameter	width	Parameter specifying the width of the editing box.

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
WebContent(NamedObj container, java.lang.String name)	Create an instance of this parameter.

Method Summary

Modifier and Type	Method	Description
protected void	_provideAttributes(WebExporter exporter)	Generate attribute web content.
protected void	_provideElements(WebExporter exporter)	Generate element web content.
void	attributeChanged(Attribute attribute)	Override the base class to update the icon.
java.lang.Object	clone(Workspace workspace)	Clone the object into the specified workspace.
void	provideContent(WebExporter exporter)	Provide content to the specified web exporter.

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

getMimeType, isOverwriteable

Field Detail

displayText

public StringParameter displayText

Parameter giving the text to display in the Ptolemy model. This defaults to "Content for Export to Web".

height

public Parameter height

Parameter specifying the height of the editing box. This is an int that defaults to 20.

width

public Parameter width

Parameter specifying the width of the editing box. This is an int that defaults to 60.

_icon

protected TextIcon _icon

Icon.

Constructor Detail

WebContent

public WebContent(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

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

Override the base class to update the icon.

Overrides:

attributeChanged in class Variable

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If thrown while setting the icon text or by the superclass.

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the object into the specified workspace.

Overrides:

clone in class Parameter

Parameters:

workspace - The workspace for the new object.

Returns:

A new NamedObj.

Throws:

java.lang.CloneNotSupportedException - If any of the attributes cannot be cloned.

See Also:

Object.clone()

provideContent

public void provideContent(WebExporter exporter)
                    throws IllegalActionException

Provide content to the specified web exporter. This may include, for example, HTML pages and fragments, Javascript function definitions and calls, CSS styling, and more. Throw an IllegalActionException if something is wrong with the web content. Calls two methods, _provideAttributes() for generating content that would be an attribute of an element and _provideElements() for generating standalone elements. Note that attributes may refer to other elements; therefore, the provideContent() method always calls both _provideAttributes() and _provideElements(). For example, a HTML attribute for a Javascript method call: onclick="runMethod()" requires that a <script> function runMethod() { } </script> element be defined. Subclasses should override _provideAttributes() and _provideElements().

Specified by:

provideContent in interface WebExportable

Parameters:

exporter - The web exporter to be used

Throws:

IllegalActionException - If something is wrong with the web content.

_provideAttributes

protected void _provideAttributes(WebExporter exporter)
                           throws IllegalActionException

Generate attribute web content. Should call WebExporter's defineAttribute() method. Subclasses should override. Please also see WebAttribute

Parameters:

exporter - The WebExporter to write content to

Throws:

IllegalActionException - If there is a problem creating the web content.

_provideElements

protected void _provideElements(WebExporter exporter)
                         throws IllegalActionException

Generate element web content. Should call WebExporter's defineElement() method. Subclasses should override. Please also see WebElement

Parameters:

exporter - The WebExporter to write content to

Throws:

IllegalActionException - If there is a problem creating the web content.