ptolemy.vergil.toolbox
Class GraphicElement

java.lang.Object
  extended byptolemy.vergil.toolbox.GraphicElement

public class GraphicElement
extends java.lang.Object

An GraphicElement is an atomic piece of a graphical representation. i.e. a line, box, textbox, etc.

Since:
Ptolemy II 1.0
Version:
$Id: GraphicElement.java,v 1.25 2004/04/13 05:12:44 cxh Exp $
Author:
Steve Neuendorffer, John Reekie
Accepted Rating:
Red (johnr)
Proposed Rating:
Yellow (neuendor)

Constructor Summary
GraphicElement(java.lang.String type)
          Create a new GraphicElement with the given type.
 
Method Summary
 java.util.Set attributeNameSet()
          Return a set of all the attribute names.
 boolean containsAttribute(java.lang.String name)
          Test if this element has an attribute with the given name.
 void exportMoML(java.io.Writer out, java.lang.String prefix)
          Write the GraphicElement in XML format to the given writer.
 java.lang.String getAttribute(java.lang.String name)
          Return the value of the attribute with the given name.
 java.lang.String getLabel()
          Return the label of this graphic element.
 PaintedObject getPaintedObject()
          Return a new painted object that looks like this graphic element.
 java.lang.String getType()
          Return the type of this graphic element.
 void removeAttribute(java.lang.String name)
          Remove an attribute from this element.
 void setAttribute(java.lang.String name, java.lang.String value)
          Set the attribute with the given name to the given value.
 void setLabel(java.lang.String name)
          Set the label for this graphic element.
 java.lang.String toString()
          Return a string this representing this GraphicElement.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GraphicElement

public GraphicElement(java.lang.String type)
Create a new GraphicElement with the given type. By default, the GraphicElement contains no attributes and an empty label

Method Detail

attributeNameSet

public java.util.Set attributeNameSet()
Return a set of all the attribute names.


getType

public java.lang.String getType()
Return the type of this graphic element. The type is immutably set when the element is created.


getAttribute

public java.lang.String getAttribute(java.lang.String name)
Return the value of the attribute with the given name. Throw an exception if there is no attribute with the given name in this schematic.


getLabel

public java.lang.String getLabel()
Return the label of this graphic element. This is primarily useful for textual elements, but may be used for other objects that have a label.


getPaintedObject

public PaintedObject getPaintedObject()
Return a new painted object that looks like this graphic element. If the attributes are not consistent, or another error occurs, then return a painted string containing "Error!".


containsAttribute

public boolean containsAttribute(java.lang.String name)
Test if this element has an attribute with the given name.


removeAttribute

public void removeAttribute(java.lang.String name)
Remove an attribute from this element.


setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)
Set the attribute with the given name to the given value.


setLabel

public void setLabel(java.lang.String name)
Set the label for this graphic element.


toString

public java.lang.String toString()
Return a string this representing this GraphicElement.


exportMoML

public void exportMoML(java.io.Writer out,
                       java.lang.String prefix)
                throws java.io.IOException
Write the GraphicElement in XML format to the given writer.

Throws:
java.io.IOException