org.zimowski.bambi.editor.plugins.api

Class AbstractImageExporter

java.lang.Object

javax.swing.SwingWorker<Void,Void>

org.zimowski.bambi.editor.plugins.api.AbstractPlugin

org.zimowski.bambi.editor.plugins.api.AbstractImagePlugin

org.zimowski.bambi.editor.plugins.api.AbstractImageExporter

All Implemented Interfaces:

Runnable, Future<Void>, RunnableFuture<Void>, ImageExporter, ImagePlugin, Plugin

Direct Known Subclasses:

FilesystemImageExporter, FtpImageUploader, MultipartFormPostImageUploader

public abstract class AbstractImageExporter
extends AbstractImagePlugin
implements ImageExporter

Base for image export plugins. Since any export process could be time consuming, the work must be done off the EDT so that GUI remains responsive. Plugins deriving from this base must override SwingWorker.doInBackground() with the actual export logic along with proper notifications of monitor members. The done() is already implemented as it informs monitors that the export has finished, but deriving class might want to override it (ensuring to call base version first!), if cleanup or additional post-processing is desired. All parameters from #export(ImageExportDef), which is fully implemented and need not be overriden, are exposed within the protected member with an identical name.

Author:

Adam Zimowski (mrazjava)

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_TOOTLIP Property key for tooltip
protected ImageExportDef	exportDef Upload definition objects
protected Component	parent UI parent component; may be null if not provided

Fields inherited from class org.zimowski.bambi.editor.plugins.api.AbstractImagePlugin

selectorId

Fields inherited from class org.zimowski.bambi.editor.plugins.api.AbstractPlugin

configuration

Constructor Summary

Constructors

Constructor and Description
AbstractImageExporter()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	done()
void	export(ImageExportDef uploadDef, Component parent) Initiates and executes the image export process.
String	getTooltip(Locale locale) Retrieves tooltip from plugin's configuration.

Methods inherited from class org.zimowski.bambi.editor.plugins.api.AbstractImagePlugin

setSelectorId

Methods inherited from class org.zimowski.bambi.editor.plugins.api.AbstractPlugin

initialize

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, doInBackground, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zimowski.bambi.editor.plugins.api.ImagePlugin

setSelectorId

Methods inherited from interface org.zimowski.bambi.editor.plugins.api.Plugin

initialize

Field Detail

CONFIG_TOOTLIP

public static final String CONFIG_TOOTLIP

Property key for tooltip

See Also:

Constant Field Values

exportDef

protected ImageExportDef exportDef

Upload definition objects

parent

protected Component parent

UI parent component; may be null if not provided

Constructor Detail

AbstractImageExporter

public AbstractImageExporter()

Method Detail

export

public void export(ImageExportDef uploadDef,
          Component parent)

Description copied from interface: ImageExporter

Initiates and executes the image export process. Implementing class is responsible for notifying all monitor objects which in turn update the UI. Without proper notifications the UI will not report export's progress to end user. It is also up to the implementing class to listen to abort agent for notification that export abort has been issued (not required though highly recommended).

Specified by:

export in interface ImageExporter

Parameters:

uploadDef - export processing parameters

done

protected void done()

Overrides:

done in class SwingWorker<Void,Void>

getTooltip

public String getTooltip(Locale locale)

Retrieves tooltip from plugin's configuration. The tooltip is looked under configuration key in the format of XXX.ISO where XXX is CONFIG_TOOTLIP, dot is ConfigLoader.PARAM_SEPARATOR, and ISO is Locale.getISO3Language(). If locale specific value is not found, a second search is done just for CONFIG_TOOTLIP. If that yields no result, null is returned.

Specified by:

getTooltip in interface ImageExporter

Parameters:

locale - language locale

Returns:

tooltip for this plugin's operation that could be attached to a toolbar button