ptolemy.vergil.basic.export.web

Class HTMLImage

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.HTMLImage

All Implemented Interfaces:

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

public class HTMLImage
extends WebContent

Attribute for inserting an image into a web page. Drag this attribute onto an actor that produces a BasicGraphFrame (for example, ptolemy.actor.lib.gui.XYPlotter) and specify the caption for this image. By default, this image will be placed at the end of the HTML page, but you can change the position by setting the imagePosition parameter. You can also separately control what text is displayed in the model, or make the attribute disappear altogether in the model (for this, just set displayText to an empty string). Based on ptolemy.vergil.basic.export.web.HTMLText

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Beth Latronico

See Also:

ImageExportable, HTMLText, LinkToOpenTableaux

Pt.AcceptedRating:

Red (ltrnc)

Pt.ProposedRating:

Red (ltrnc)

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 and Description
HTMLTextPosition	imagePosition Parameter specifying the position into which to export the image.

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

Method Summary

Modifier and Type	Method and Description
void	_provideElements(WebExporter exporter) Generate the image file and a <table> element holding an <img/> element and a caption for the image..
java.lang.String	getMimeType() Return image plus the appropriate file extension, e.g. image/gif
boolean	isOverwriteable() Return true, since old images should be overwritten with new.

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

_provideAttributes, 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, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Settable

getDisplayName

Field Detail

imagePosition

public HTMLTextPosition imagePosition

Parameter specifying the position into which to export the image. The parameter offers the following possibilities:

• end: Put the image at the end of the HTML file.
• header: Put the image in the header section.
• start: Put the image at the start of the body section.
• anything_else: Put the image in a separate HTML file named anything_else.

The default is "start".

Constructor Detail

HTMLImage

public HTMLImage(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()

Return image plus the appropriate file extension, e.g. image/gif

Returns:

image plus the appropriate file extension, e.g. image/gif

isOverwriteable

public boolean isOverwriteable()

Return true, since old images should be overwritten with new.

Returns:

True, since old images should be overwritten with new

_provideElements

public void _provideElements(WebExporter exporter)
                      throws IllegalActionException

Generate the image file and a <table> element holding an <img/> element and a caption for the image..

Overrides:

_provideElements in class WebContent

Parameters:

exporter - The WebExporter to add content to

Throws:

IllegalActionException - If something is wrong generating the image file or generating the additional web content