ptolemy.vergil.basic.export.web

Interface WebExportable

All Superinterfaces:

Nameable

All Known Implementing Classes:

DefaultIconLink, DefaultIconScript, DefaultTitle, DygraphsJSPlotterAttribute, HTMLImage, HTMLText, IconLink, IconScript, JSPlotterAttribute, LinkToOpenTableaux, ParameterDisplayIconScript, Script, Title, WebContent

public interface WebExportable
extends Nameable

Interface for parameters that provide web export content.

Since:

Ptolemy II 10.0

Version:

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

Author:

Edward A. Lee, Elizabeth Latronico

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMimeType() Return the Mime type of the content (for example, text/html).
boolean	isOverwriteable() Returns true if the content in the WebExporter for this object should be overwritten; false if the original content should be kept.
void	provideContent(WebExporter exporter) Provide content to the specified web exporter.

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Method Detail

getMimeType

java.lang.String getMimeType()

Return the Mime type of the content (for example, text/html). The Mime type is used by browsers to determine how to render the content. The Mime type is set using HttpResponse's setContentType() method. Please see the list of Mime types here, in the Media type and subtype(s) field of the table: http://reference.sitepoint.com/html/mime-types-full

Returns:

The Mime type of the content (for example, text/html)

isOverwriteable

boolean isOverwriteable()

Returns true if the content in the WebExporter for this object should be overwritten; false if the original content should be kept. Note that all objects from the WebExportable are treated in a uniform manner. For example, it's not possible to overwrite some objects' values but keep other objects' values from the same WebExportable.

Returns:

True if the content in the WebExporter for this object should be overwritten; false if the original content should be kept

provideContent

void provideContent(WebExporter exporter)
             throws IllegalActionException

Provide content to the specified web exporter. This may include, for example, HTML pages and fragments, Javascript function definitions and calls, CSS styling, and more. Throw an IllegalActionException if something is wrong with the web content.

Parameters:

exporter - The web exporter to be used

Throws:

IllegalActionException - If something is wrong with the web content.