org.pf.joi
Interface ExportProvider

public interface ExportProvider

Defines the interface that export classes must comply to.
The purpose of an ExportProvider is to write the inspector's displayed object information to external sources (e.g. files).

Version:

1.0

Author:

Manfred Duchrow

Method Summary

boolean	export(AbstractObjectSpy objSpy, java.awt.Frame parent) An export method that allows the provider to show a dialog (e.g. file dialog) before actually writing the data.
boolean	export(AbstractObjectSpy objSpy, java.lang.String filename) An export method that writes the data immediately to the file with the specified name.
java.lang.String	exportLabel() Returns the label that will be shown in an inspector's 'File' menu.
java.lang.String	getVendor() Returns the vendor of the provider
java.lang.String	getVersion() Returns the version of the provider

Method Detail

getVersion

java.lang.String getVersion()

Returns the version of the provider

getVendor

java.lang.String getVendor()

Returns the vendor of the provider

export

boolean export(AbstractObjectSpy objSpy,
               java.awt.Frame parent)
               throws java.lang.Exception

An export method that allows the provider to show a dialog (e.g. file dialog) before actually writing the data.

Parameters:

objSpy - The wrapped object to be exported

parent - The parent window. Usually that is the inspector window

Throws:

java.lang.Exception

export

boolean export(AbstractObjectSpy objSpy,
               java.lang.String filename)
               throws java.lang.Exception

An export method that writes the data immediately to the file with the specified name.

Parameters:

objSpy - The wrapped object to be exported

filename - The name of the output file

Throws:

java.lang.Exception

exportLabel

java.lang.String exportLabel()

Returns the label that will be shown in an inspector's 'File' menu.