ptolemy.actor.gui
Class HTMLEffigyFactory

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.kernel.CompositeEntity
                      ptolemy.actor.gui.EffigyFactory
                          ptolemy.actor.gui.HTMLEffigyFactory

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class HTMLEffigyFactory
extends EffigyFactory

A factory for creating new effigies for HTML pages.

Since:

Ptolemy II 1.0

Version:

$Id: HTMLEffigyFactory.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Steve Neuendorffer and Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Red (neuendor)

Proposed Rating:

Red (neuendor)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.CompositeEntity

CompositeEntity.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.kernel.CompositeEntity

_levelCrossingLinks

Fields inherited from class ptolemy.kernel.util.NamedObj

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

Constructor Summary

HTMLEffigyFactory(CompositeEntity container, java.lang.String name)
Create a factory with the given name and container.

HTMLEffigyFactory(Workspace workspace)
Create a factory in the specified workspace.

Method Summary

boolean	canCreateBlankEffigy() Return false, indicating that this effigy factory is not capable of creating an effigy without a URL being specified.
Effigy	createEffigy(CompositeEntity container, java.net.URL base, java.net.URL in) Create a new effigy in the given container by reading the specified URL.

Methods inherited from class ptolemy.actor.gui.EffigyFactory

checkForDTD, createEffigy, getExtension

Methods inherited from class ptolemy.kernel.CompositeEntity

_addEntity, _addRelation, _adjustDeferrals, _deepOpaqueEntityList, _description, _exportMoMLContents, _finishedAddEntity, _recordDecoratedAttributes, _removeEntity, _removeRelation, _validateSettables, allAtomicEntityList, allCompositeEntityList, allowLevelCrossingConnect, classDefinitionList, clone, connect, connect, containedObjectsIterator, deepEntityList, deepGetEntities, deepOpaqueEntityList, deepRelationSet, entityList, entityList, exportLinks, exportMoML, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, isOpaque, lazyAllAtomicEntityList, lazyAllCompositeEntityList, lazyClassDefinitionList, lazyDeepEntityList, lazyEntityList, lazyRelationList, newRelation, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, setClassDefinition, setContainer, statistics, uniqueName

Methods inherited from class ptolemy.kernel.ComponentEntity

_addPort, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, newPort, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_removePort, connectedPortList, connectedPorts, connectionsChanged, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, 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.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getDisplayName, getFullName, getName, getName

Constructor Detail

HTMLEffigyFactory

public HTMLEffigyFactory(Workspace workspace)

Create a factory in the specified workspace.

Parameters:

workspace - The workspace.

HTMLEffigyFactory

public HTMLEffigyFactory(CompositeEntity container,
                         java.lang.String name)
                  throws IllegalActionException,
                         NameDuplicationException

Create a factory with the given name and container.

Parameters:

container - The container.

name - The name.

Throws:

IllegalActionException - If the container is incompatible with this entity.

NameDuplicationException - If the name coincides with an entity already in the container.

Method Detail

canCreateBlankEffigy

public boolean canCreateBlankEffigy()

Return false, indicating that this effigy factory is not capable of creating an effigy without a URL being specified. There is no point in creating an unmodifiable blank HTML page.

Overrides:

canCreateBlankEffigy in class EffigyFactory

Returns:

False.

createEffigy

public Effigy createEffigy(CompositeEntity container,
                           java.net.URL base,
                           java.net.URL in)
                    throws java.lang.Exception

Create a new effigy in the given container by reading the specified URL. The extension of the URL must be ".htm" or ".html", or the content type must be "text/html" or "text/rtf". Otherwise, this returns null. It will also return null if there is no access to the network.

Overrides:

createEffigy in class EffigyFactory

Parameters:

container - The container for the effigy.

base - The base for relative file references, or null if there are no relative file references. This is ignored in this class.

in - The input URL.

Returns:

A new instance of HTMLEffigy, or null if one cannot be created.

Throws:

java.lang.Exception - If the URL cannot be read, or if the data is malformed in some way.