org.kepler.gui

Class KeplerXMLIcon

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.vergil.icon.EditorIcon

ptolemy.vergil.icon.DynamicEditorIcon

ptolemy.vergil.icon.XMLIcon

org.kepler.gui.KeplerXMLIcon

All Implemented Interfaces:

java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, IconAttribute, ModelErrorHandler, MoMLExportable, Moveable, Nameable, ValueListener

public class KeplerXMLIcon
extends XMLIcon
implements ValueListener

An icon is a visual representation of an entity. Three such visual representations are supported here. A background figure is returned by the createBackgroundFigure() method. This figure is specified by an attribute named "_iconDescription" of the container, if there is one. If there is no such attribute, then a default icon is used. The createFigure() method returns this same background figure, but decorated with a label giving the name of the container, unless the container contains a parameter named "_hideName" with value true. The createIcon() method returns a Swing icon given by an attribute named "_smallIconDescription", if there is one. If there is no such attribute, then the icon is simply a small representation of the background figure.

The XML schema used in the "_iconDescription" and "_smallIconDescription" attributes is SVG (scalable vector graphics), although currently Diva only supports a small subset of SVG.

Since:

Ptolemy II 2.0

Author:

Chad Berkley, based on XMLIcon by Steve Neuendorffer, John Reekie, Contributor: Edward A. Lee

Pt.AcceptedRating:

Red (johnr)

Pt.ProposedRating:

Yellow (neuendor)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.vergil.icon.DynamicEditorIcon

_figures

Fields inherited from class ptolemy.vergil.icon.EditorIcon

_containerToBe, _iconCache

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

Constructor Summary

Constructors

Constructor and Description
KeplerXMLIcon(NamedObj container, java.lang.String name) Create a new icon with the given name in the given container.
KeplerXMLIcon(Workspace workspace, java.lang.String name) Construct an icon in the specified workspace and name.

Method Summary

Modifier and Type	Method and Description
diva.canvas.Figure	createBackgroundFigure() Create a background Figure based on this icon.
javax.swing.Icon	createIcon() Create a new Swing icon to use as a thumbnail in the Actor Library.
java.lang.String	toString() Return a string representing this Icon.
void	valueChanged(Settable settable) React to the fact that the value of an attribute named "_iconDescription" contained by the same container has changed value by redrawing the figure.

Methods inherited from class ptolemy.vergil.icon.XMLIcon

_description, _recreateFigure, clone, getXMLIcon, getXMLIcon, paintedList

Methods inherited from class ptolemy.vergil.icon.DynamicEditorIcon

_addLiveFigure, _liveFigureIterator, _trimLiveFigures

Methods inherited from class ptolemy.vergil.icon.EditorIcon

_createDefaultBackgroundFigure, _isPropertySet, createFigure, getContainerOrContainerToBe, setContainerToBe

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, setName, 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, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, 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

Constructor Detail

KeplerXMLIcon

public KeplerXMLIcon(Workspace workspace,
                     java.lang.String name)
              throws IllegalActionException

Construct an icon in the specified workspace and name. This constructor is typically used in conjunction with setContainerToBe() and createFigure() to create an icon and generate a figure without having to have write access to the workspace. If the workspace argument is null, then use the default workspace. The object is added to the directory of the workspace.

Parameters:

workspace - The workspace that will list the attribute.

name - String

Throws:

IllegalActionException - If the specified name contains a period.

See Also:

Increment the version number of the workspace.

KeplerXMLIcon

public KeplerXMLIcon(NamedObj container,
                     java.lang.String name)
              throws NameDuplicationException,
                     IllegalActionException

Create a new icon with the given name in the given container. By default, the icon contains no graphic objects.

Parameters:

container - The container for this attribute.

name - The name of this attribute.

Throws:

NameDuplicationException

IllegalActionException

Method Detail

createBackgroundFigure

public diva.canvas.Figure createBackgroundFigure()

Create a background Figure based on this icon. Looks for attributes in the following order, stopping if a match is found: 1) "_svgIcon", which contains a pointer (typically a classpath-relative file path). If it exists, uses it to create the background Figure 2) "_iconDescription", which contains an xml simple-svg description. If it exists, uses it to create the icon, using the simple Diva rendering system If no match is found, it simply defers to the base class.

Overrides:

createBackgroundFigure in class XMLIcon

Returns:

A figure for this icon.

createIcon

public javax.swing.Icon createIcon()

Create a new Swing icon to use as a thumbnail in the Actor Library. Looks for attributes in the following order, stopping if a match is found: 1) if SVG_BATIK_RENDERING enabled - looks for "_thumbnailRasterIcon", which contains a pointer (typically a classpath-relative file path). If it exists, uses it to create the thumbnail icon. If (a) it doesn't exist, or (b) if rendering method is SVG_DIVA_RENDERING, proceed to next step, since (a) we're dealing with an annotation or shape actor etc, or (b) we don't want to render the new-style thumbnail and the old-style actor icons. 2) "_smallIconDescription", which contains an xml simple-svg description. If it exists, uses it to create the icon, using the simple Diva rendering system If no match is found, a default image is used, as follows: 3) looks for a cached actor icon (_bgFigure). 4) If no cached one is available, it creates a scaled version of the background figure by calling _divaCreateBackgroundFigure(), using the old-style Diva svg rendering to render the xml simple-svg description in the "_iconDescription" attribute, if it exists. Uses old diva rendering because batik is very memory intensive, and is not required for this task. 5) If all else fails, it simply defers to the base class.

Overrides:

createIcon in class XMLIcon

Returns:

A Swing Icon.

toString

public java.lang.String toString()

Return a string representing this Icon.

Overrides:

toString in class XMLIcon

Returns:

String

valueChanged

public void valueChanged(Settable settable)

React to the fact that the value of an attribute named "_iconDescription" contained by the same container has changed value by redrawing the figure.

Specified by:

valueChanged in interface ValueListener

Overrides:

valueChanged in class XMLIcon

Parameters:

settable - The object that has changed value.