Package com.biomatters.geneious.publicapi.plugin

Class DocumentFileExporterAndExternalViewer

java.lang.Object

com.biomatters.geneious.publicapi.plugin.DocumentFileExporter

com.biomatters.geneious.publicapi.plugin.DocumentFileExporterAndExternalViewer

public abstract class DocumentFileExporterAndExternalViewer
extends DocumentFileExporter

A file exporter with an associated external viewer.

An external viewer typically reads a file from the file system, so it is natural to associate an external viewer with an exporter since the documents have to be written to disk prior to external viewer invocation.

Field Summary

Fields inherited from class com.biomatters.geneious.publicapi.plugin.DocumentFileExporter

REPLACE_SPACES_IN_SEQUENCE_NAMES_OPTION_NAME

Constructor Summary

Constructors

Constructor	Description
DocumentFileExporterAndExternalViewer()

Method Summary

Modifier and Type	Method	Description
abstract String[]	defaultLinuxViewers()	Linux application name(s) of viewers.
abstract String	viewerAppEnvironmentVariableName()	Name of environment variable which let user specify her preferred external viewer.

Methods inherited from class com.biomatters.geneious.publicapi.plugin.DocumentFileExporter

export, export, getDefaultExtension, getFileTypeDescription, getOptions, getOptions, getOptionsForBatchExport, getProgrammaticOptions, getSelectionSignatures, getUniqueId, isProOnly, mayDiscardInformation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentFileExporterAndExternalViewer

public DocumentFileExporterAndExternalViewer()

Method Details

viewerAppEnvironmentVariableName

public abstract String viewerAppEnvironmentVariableName()

Name of environment variable which let user specify her preferred external viewer.

Not required on Windows or Mac if file type is known to the operating system. On Linux a viewer will typically specify one or more default options via defaultLinuxViewers, so that a viewer may be found eeven when no environment variables are set.

Returns:

environment variable name

defaultLinuxViewers

public abstract String[] defaultLinuxViewers()

Linux application name(s) of viewers.

Returns:

A list of application names capable of displaying the document(s).