Package ptolemy.vergil.basic.export.web

Class DefaultIconLink

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

All Implemented Interfaces:

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

Direct Known Subclasses:

LinkToOpenTableaux

public class DefaultIconLink
extends IconLink

A parameter specifying default hyperlink to associate with icons in model. Putting this attribute into a model causes the icons of entities, attributes, or both, to be assigned a default hyperlink to the URI given by linkTarget. This will replace any configuration default link that includes the same objects, and targets the same instanceOf possibilities.

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 link for Attributes, Entities, or both.
StringParameter	instancesOf	If non-empty (the default), specifies a class name.

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

Method Summary

Modifier and Type	Method	Description
protected void	_provideAttributes(WebExporter exporter)	Override the base class to define an href attribute to associate with the area of the image map corresponding to its container.
protected void	_provideEachAttribute(WebExporter exporter, NamedObj object)	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.IconLink

getMimeType, isOverwriteable

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 control defined by this DefaultIconLink parameter.

include

public StringParameter include

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

Constructor Detail

DefaultIconLink

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

_provideAttributes

protected void _provideAttributes(WebExporter exporter)
                           throws IllegalActionException

Override the base class to define an href attribute to associate with the area of the image map corresponding to its container.

Overrides:

_provideAttributes in class IconLink

Parameters:

exporter - The web exporter to which to write content.

Throws:

IllegalActionException - If evaluating the value of this parameter fails.

_provideEachAttribute

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

Provide content to the specified web exporter to be included in a web page for the container of this object. This class defines an href attribute to associate with the area of the image map corresponding to its container.

Parameters:

exporter - The exporter.

object - The object.

Throws:

IllegalActionException - If evaluating the value of this parameter fails.