ptolemy.vergil.basic

Interface HTMLExportable

All Known Implementing Classes:

ActorGraphFrame, BasicGraphFrame, CaseGraphFrame, EditIconFrame, ExportHTMLAction, ExtendedGraphFrame, FmvAutomatonGraphFrame, FSMGraphFrame, GTFrame, InterfaceAutomatonGraphFrame, MatchResultViewer, NavigableActorGraphFrame, OntologyGraphFrame, OntologySolverGraphFrame, PteraGraphFrame, TransformationEditor

public interface HTMLExportable

Interface for parameters and attribute indicating support for exporting an HTML file and supporting files.

Since:

Ptolemy II 10.0

Version:

$Id: HTMLExportable.java 67784 2013-10-26 16:53:27Z cxh $

Author:

Edward A. Lee

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Method Summary

Modifier and Type	Method and Description
void	writeHTML(ExportParameters parameters, java.io.Writer writer) Export to HTML as given by the parameters.

Method Detail

writeHTML

void writeHTML(ExportParameters parameters,
               java.io.Writer writer)
        throws java.awt.print.PrinterException,
               java.io.IOException,
               IllegalActionException

Export to HTML as given by the parameters. Implementers should write an "index.html" file plus any required supporting files in the directory given in the parameters. The caller is responsible for checking with the user whether any contents of the specified directory can be overwritten.

Parameters:

parameters - The parameters for the export.

writer - The writer to use the write the HTML. If this is null, then the implementer should create an index.html file in the directory given by the directoryToExportTo field of the parameters.

Throws:

java.io.IOException - If unable to write any files.

java.awt.print.PrinterException - If unable to write associated files.

IllegalActionException - If something goes wrong.