net.sf.jguiraffe.examples.tutorial.mainwnd

Class AbstractDesktopTask

java.lang.Object

net.sf.jguiraffe.examples.tutorial.mainwnd.AbstractDesktopTask

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

EditDesktopTask, OpenDesktopTask, PrintDesktopTask

public abstract class AbstractDesktopTask
extends Object
implements Runnable

An abstract base class for action tasks that perform a desktop operation with the currently selected file.

The tutorial application defines some actions for doing something with files which is implemented by the Desktop class new in Java 1.6 (e.g. opening a file or printing it). This abstract base class provides basic functionality for implementing such functionality. It is initialized with a reference to the main controller from which the currently selected file can be obtained. It also takes care for exception handling. A concrete subclass only has to implement the desired Desktop operation.

Version:

$Id: AbstractDesktopTask.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log The logger.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDesktopTask(MainWndController ctrl) Creates a new instance of AbstractDesktopTask and sets the reference to the main controller.

Method Summary

Modifier and Type	Method and Description
MainWndController	getController() Returns a reference to the main controller.
File	getSelectedFile() Returns the selected file.
protected abstract void	performDesktopOperation(Desktop desktop) Performs the desired operation with the selected file.
void	run() Executes this task.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

The logger.

Constructor Detail

AbstractDesktopTask

protected AbstractDesktopTask(MainWndController ctrl)

Creates a new instance of AbstractDesktopTask and sets the reference to the main controller.

Parameters:

ctrl - the main controller reference

Method Detail

getController

public MainWndController getController()

Returns a reference to the main controller.

Returns:

the main controller

getSelectedFile

public File getSelectedFile()

Returns the selected file.

Returns:

the selected file

run

public void run()

Executes this task. This implementation creates a new command for executing the desktop operation.

Specified by:

run in interface Runnable

performDesktopOperation

protected abstract void performDesktopOperation(Desktop desktop)
                                         throws Exception

Performs the desired operation with the selected file. This method has to be implemented by concrete subclasses.

Parameters:

desktop - the Desktop instance

Throws:

Exception - if an error occurs