ptolemy.actor.gui
Class GenerateCopyrights

java.lang.Object
  extended byptolemy.actor.gui.GenerateCopyrights

public class GenerateCopyrights
extends java.lang.Object

Generate an HTML file that contains links to the appropriate copyrights for entities in the configuration. This class looks for particular classes, and if the class is found in the classpath, then a corresponding html file is included in the list of copyrights.

Since:
Ptolemy II 2.0
Version:
$Id: GenerateCopyrights.java,v 1.38.2.1 2004/06/18 00:48:51 cxh Exp $
Author:
Christopher Hylands
Accepted Rating:
Red (cxh)
Proposed Rating:
Red (cxh)

Constructor Summary
GenerateCopyrights()
           
 
Method Summary
static java.lang.String generateHTML(Configuration configuration)
          Generate HTML about the copyrights for classes that might be present in the configuration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GenerateCopyrights

public GenerateCopyrights()
Method Detail

generateHTML

public static java.lang.String generateHTML(Configuration configuration)
Generate HTML about the copyrights for classes that might be present in the configuration. This method contains a list of classes and corresponding copyrights. If a class in the list is present, then we generate html that contains a link to the copyright. Note that if the copyright file need not be present on the local machine, we generate a link to the copy on the Ptolemy website.

If the configuration contains an _applicationName attribute then that attributed is used as the name of the application in the generated text. If _applicationName is not present, then the default name is "Ptolemy II".

If the configuration contains an _applicationCopyright StringAttribute, then the value of that attributed is used as the location of the copyright html file. If _applicationCopyright is not present, then "ptolemy/configs/doc/copyright.htm" is used.

Parameters:
configuration - The configuration to look for the _applicationName and _applicationCopyright attributes in.
Returns:
A String containing HTML that describes what copyrights are used by Entities in the configuration