org.trianacode.gui.extensions

Class AbstractFormatFilter

java.lang.Object

org.trianacode.gui.extensions.AbstractFormatFilter

Direct Known Subclasses:

DaxReaderGUIInterface, IwirExporter, IwirReader

public abstract class AbstractFormatFilter
extends java.lang.Object

Common methods used by all format filters in Triana. A format filter is a mechanism by which Triana is able to import other workflow or taskgraph formats into the internal format, export the internal format to other external formats or import tools to the component library.

Format filters are used as extensions to a JFileDialog to automatically provide extensions to filter files and handle their import or export.

Constructor Summary

Constructors

Constructor and Description
AbstractFormatFilter()

Method Summary

Methods

Modifier and Type	Method and Description
abstract javax.swing.filechooser.FileFilter[]	getChoosableFileFilters() Gets the list of choosable file filters.
abstract javax.swing.filechooser.FileFilter	getDefaultFileFilter() Returns the default choosable file filter.
abstract java.lang.String	getFilterDescription() Short description of the filter that will appear as the selection item in the list of filters.
abstract boolean	hasOptions() Returns true if this filter has user configurable options, false otherwise.
abstract int	showOptionsDialog(java.awt.Component parent) Pops up a the options dialog for this filter if there is one
java.lang.String	toString() Overrides the default toString method to return the filter description

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFormatFilter

public AbstractFormatFilter()

Method Detail

getFilterDescription

public abstract java.lang.String getFilterDescription()

Short description of the filter that will appear as the selection item in the list of filters.

getChoosableFileFilters

public abstract javax.swing.filechooser.FileFilter[] getChoosableFileFilters()

Gets the list of choosable file filters.

Returns:

A FileFilter array containing all choosable file filters.

getDefaultFileFilter

public abstract javax.swing.filechooser.FileFilter getDefaultFileFilter()

Returns the default choosable file filter.

Returns:

the default file filter

hasOptions

public abstract boolean hasOptions()

Returns true if this filter has user configurable options, false otherwise.

Returns:

true if this filter has user options

showOptionsDialog

public abstract int showOptionsDialog(java.awt.Component parent)

Pops up a the options dialog for this filter if there is one

Parameters:

parent - the parent component of the dialog, can be null; see showDialog for details

Returns:

the return state of the file chooser on popdown:

• JFileChooser.CANCEL_OPTION
• JFileChooser.APPROVE_OPTION
• JFileCHooser.ERROR_OPTION if an error occurs or the dialog is dismissed

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless()

toString

public java.lang.String toString()

Overrides the default toString method to return the filter description

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.