Package ptolemy.moml.filter

Class AddIcon

  • All Implemented Interfaces:
    MoMLFilter
    public class AddIcon
extends MoMLFilterSimple
    Certain actors have specialized icons that display the value of one of the parameters. This filter adds icons to those actors when necessary.
    Since:
    Ptolemy II 2.0
    Version:
    $Id$
    Author:
    Christopher Hylands, Edward A. Lee
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Red (cxh)

    • Constructor Summary

      Constructors 
      Constructor Description
      AddIcon()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String filterAttributeValue​(NamedObj container, java.lang.String element, java.lang.String attributeName, java.lang.String attributeValue, java.lang.String xmlFile)
      If the attributeName is "class" and attributeValue names a class that has had its port names changed between releases, then substitute in the new port names.
      void filterEndElement​(NamedObj container, java.lang.String elementName, java.lang.StringBuffer currentCharData, java.lang.String xmlFile)
      Deprecated.
      Use filterEndElement(NamedObj, String, StringBuffer, String, MoMLParser) instead and pass a MoMLParser.
      void filterEndElement​(NamedObj container, java.lang.String elementName, java.lang.StringBuffer currentCharData, java.lang.String xmlFile, MoMLParser parser)
      Make modifications to the specified container, which is defined in a MoML element with the specified name.
      java.lang.String toString()
      Return a string that describes what the filter does.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • AddIcon

        public AddIcon()

    • Method Detail

      • filterAttributeValue

        public java.lang.String filterAttributeValue​(NamedObj container,
                                             java.lang.String element,
                                             java.lang.String attributeName,
                                             java.lang.String attributeValue,
                                             java.lang.String xmlFile)
        If the attributeName is "class" and attributeValue names a class that has had its port names changed between releases, then substitute in the new port names.
        Parameters:
        container - The container for this attribute. in this method.
        element - The XML element name.
        attributeName - The name of the attribute.
        attributeValue - The value of the attribute.
        xmlFile - The file currently being parsed.
        Returns:
        the value of the attributeValue argument.

      • filterEndElement

        @Deprecated
public void filterEndElement​(NamedObj container,
                             java.lang.String elementName,
                             java.lang.StringBuffer currentCharData,
                             java.lang.String xmlFile)
                      throws java.lang.Exception
        Deprecated.
        Use filterEndElement(NamedObj, String, StringBuffer, String, MoMLParser) instead and pass a MoMLParser.
        Make modifications to the specified container, which is defined in a MoML element with the specified name.
        Parameters:
        container - The object created by this element.
        elementName - The element name.
        currentCharData - The character data, which appears only in the doc and configure elements
        xmlFile - The file currently being parsed.
        Throws:
        java.lang.Exception - if there is a problem substituting in the new value.

      • filterEndElement

        public void filterEndElement​(NamedObj container,
                             java.lang.String elementName,
                             java.lang.StringBuffer currentCharData,
                             java.lang.String xmlFile,
                             MoMLParser parser)
                      throws java.lang.Exception
        Make modifications to the specified container, which is defined in a MoML element with the specified name.
        Specified by:
        filterEndElement in interface MoMLFilter
        Overrides:
        filterEndElement in class MoMLFilterSimple
        Parameters:
        container - The object created by this element.
        elementName - The element name.
        currentCharData - The character data, which appears only in the doc and configure elements
        xmlFile - The file currently being parsed.
        parser - The parser in which MoML is optionally evaluated.
        Throws:
        java.lang.Exception - if there is a problem substituting in the new value.

      • toString

        public java.lang.String toString()
        Return a string that describes what the filter does.
        Specified by:
        toString in interface MoMLFilter
        Overrides:
        toString in class java.lang.Object
        Returns:
        the description of the filter that ends with a newline.