org.zimowski.bambi.editor.plugins.api

Interface ImageExporter

All Superinterfaces:

ImagePlugin, Plugin

All Known Implementing Classes:

AbstractImageExporter, FilesystemImageExporter, FtpImageUploader, MultipartFormPostImageUploader

public interface ImageExporter
extends ImagePlugin

Image export plugin API. Technically any class implementing this interface could serve as the plugin, but because GUI must remain responsive, in practice such class should also extend SwingWorker. There is an abstract plugin base already defined exactly for that purpose, so rather than implementing this inteface directly, extend AbstractImageExporter instead.

Author:

Adam Zimowski (mrazjava)

Method Summary

Methods

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

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

setSelectorId

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

initialize

Method Detail

export

void export(ImageExportDef exportDef,
          Component parent)

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).

Parameters:

exportDef - export processing parameters

component - visual parent component invoking a plugin; handy if plugin desires to display a dialog

getTooltip

String getTooltip(Locale locale)

Retrieves tooltip from plugin's configuration.

Parameters:

locale - language locale

Returns:

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