Package ptolemy.vergil.basic.export.web

Class LinkToOpenTableaux

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

ptolemy.vergil.basic.export.web.DefaultIconLink

ptolemy.vergil.basic.export.web.LinkToOpenTableaux

All Implemented Interfaces:

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

public class LinkToOpenTableaux
extends DefaultIconLink

A parameter specifying default hyperlink to associate with icons in model. Putting this into a model causes a hyperlink to be associated with each icon (as specified by the include and instancesOf parameters) that is associated to an open Tableau. If the the frame associated with the tableau implements HTMLExportable, then this is an ordinary link to the HTML exported by the frame. If it instead implements ImageExportable, then this a link that brings up the image in a lightbox.

This parameter is designed to be included in a Configuration file to specify global default behavior for export to Web. Just put it in the top level of the Configuration, and this hyperlink will be provided by default.

Note that this class works closely with ExportHTMLAction. It will not work if the WebExporter provided to its methods is not an instance of ExportHTMLAction.

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 inherited from class ptolemy.vergil.basic.export.web.DefaultIconLink

include, instancesOf

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

linkTarget

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

Method Summary

Modifier and Type	Method	Description
protected void	_provideEachAttribute(WebExporter exporter, NamedObj object)	Override the base class to generate a web page or an image file for the specified object, if appropriate, and to provide the href, target, and class attributes to the area attribute associated with the object.
void	provideContent(WebExporter exporter)	Provide content to the specified web exporter to be included in a web page for the container of this object.

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

_provideAttributes

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

getMimeType, isOverwriteable

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

_provideElements, attributeChanged, clone

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

Constructor Detail

LinkToOpenTableaux

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

provideContent

public void provideContent(WebExporter exporter)
                    throws IllegalActionException

Provide content to the specified web exporter to be included in a web page for the container of this object. This overrides the base class to ensure that each class definition is exported only once.

Specified by:

provideContent in interface WebExportable

Overrides:

provideContent in class WebContent

Parameters:

exporter - The web exporter to be used

Throws:

IllegalActionException - If a subclass throws it.

_provideEachAttribute

protected void _provideEachAttribute(WebExporter exporter,
                                     NamedObj object)
                              throws IllegalActionException

Override the base class to generate a web page or an image file for the specified object, if appropriate, and to provide the href, target, and class attributes to the area attribute associated with the object.

Overrides:

_provideEachAttribute in class DefaultIconLink

Parameters:

exporter - The exporter.

object - The Ptolemy II object.

Throws:

IllegalActionException - If evaluating parameters fails.