Package ptolemy.vergil.actor

Class DocTableau

  • All Implemented Interfaces:
    java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    public class DocTableau
extends Tableau
    A tableau representing a documentation view in a toplevel window. The URL that is viewed is given by the url parameter, and can be either an absolute URL, a system fileName, or a resource that can be loaded relative to the classpath. For more information about how the URL is specified, see MoMLApplication.specToURL().

    The constructor of this class creates the window. The text window itself is an instance of DocViewer, and can be accessed using the getFrame() method. As with other tableaux, this is an entity that is contained by an effigy of a model. There can be any number of instances of this class in an effigy.

    Since:
    Ptolemy II 5.2
    Version:
    $Id$
    Author:
    Edward A. Lee
    See Also:
    Effigy, DocViewer, ConfigurationApplication.specToURL(String)
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Yellow (eal)

    • Constructor Detail

      • DocTableau

        public DocTableau​(Effigy container,
                  java.lang.String name)
           throws IllegalActionException,
                  NameDuplicationException
        Construct a new tableau for the model represented by the given effigy. This creates an instance of DocViewer. It does not make the frame visible. To do that, call show().
        Parameters:
        container - The container.
        name - The name.
        Throws:
        IllegalActionException - If the container does not accept this entity (this should not occur).
        NameDuplicationException - If the name coincides with an attribute already in the container.