Examples of ptolemy.vergil.actor.DocTableau

ptolemy.vergil.actor.DocTableau

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. @author Edward A. Lee @version $Id: DocTableau.java,v 1.7 2006/02/12 17:43:38 cxh Exp $ @since Ptolemy II 5.2 @Pt.ProposedRating Yellow (eal) @Pt.AcceptedRating Red (cxh) @see Effigy @see DocViewer @see MoMLApplication#specToURL(String)

        }
        ((DocEffigy) effigy).setDocAttribute(docAttribute);
        ComponentEntity tableau = ((Effigy) effigy).getEntity("DocTableau");
        if (tableau == null) {
            try {
                tableau = new DocTableau((DocEffigy) effigy, "DocTableau");


                ((DocTableau) tableau).setTitle("Documentation for "
                        + target.getFullName());
            } catch (KernelException exception) {
                throw new InternalErrorException(exception);
            }
        } else {
            if (isMultipleDocumentationAllowed()) {
                try {
                    // FIXME: This is necessary for Kepler, but
                    // not for Ptolemy?  Why?


                    // Create a new tableau with a unique name
                    tableau = new DocTableau((DocEffigy) effigy, effigy
                            .uniqueName("DocTableau"));
                    ((DocTableau) tableau).setTitle("Documentation for "
                            + target.getFullName());
                } catch (KernelException exception) {
                    MessageHandler.error("Failed to display documentation for "

            try {
                DocEffigy newEffigy = new DocEffigy((CompositeEntity) effigy
                        .getContainer(), effigy.getContainer().uniqueName(
                        "parentClass"));
                newEffigy.setDocAttribute(doc);
                DocTableau tableau = new DocTableau(newEffigy, "docTableau");
                tableau.show();
            } catch (KernelException e) {
                MessageHandler.error("Error opening documentation", e);
            }
            return;
        }

Examples of ptolemy.vergil.actor.DocTableau

Related Classes of ptolemy.vergil.actor.DocTableau