org.knime.core.node
Interface NodeViewExport.ExportType

Enclosing class:

NodeViewExport

public static interface NodeViewExport.ExportType

Interface for export types. This interface is currently not considered part of the public API and will change in future versions without notice.

Method Summary

void	export(File destination, Component cont, int width, int height) Called when the component is to be exported.
String	getDescription() A description for export type, this should be a one-liner such as "PNG - Portable Network Graphics" or "SVG - Scalable Vector Graphics".
String	getFileSuffix() Suffix of the file being written.

Method Detail

getDescription

String getDescription()

A description for export type, this should be a one-liner such as "PNG - Portable Network Graphics" or "SVG - Scalable Vector Graphics". It's displayed as tooltip for the default menus and also in a file chooser dialog.

Returns:

The description of the export type, not null.

getFileSuffix

String getFileSuffix()

Suffix of the file being written. The suffix should not contain a leading dot '.'. Use only, for instance "png" or "svg"

Returns:

The file suffix, not null.

export

void export(File destination,
            Component cont,
            int width,
            int height)
            throws IOException

Called when the component is to be exported.

Parameters:

destination - The destination file.

cont - The component to draw.

width - The width of the component.

height - The height of the component.

Throws:

IOException - If this fails for any reason.