com.tensegrity.skeleton.swt.launch
Class SwtLoadPreferencesLaunchTask

java.lang.Object
  com.tensegrity.gui.launch.LaunchTask
      com.tensegrity.skeleton.swing.launch.AbstractLaunchTask
          com.tensegrity.skeleton.launch.LoadFileLaunchTask
              com.tensegrity.skeleton.swt.launch.SwtLoadPreferencesLaunchTask

public class SwtLoadPreferencesLaunchTask

extends LoadFileLaunchTask

This launch task initializes the Preferences for a given SWT-based application and stores them into its corresponding SwtApplicationFrame.

Version:

$Id: SwtLoadPreferencesLaunchTask.java,v 1.14 2006/03/24 15:40:39 BurkhardWick Exp $

Author:

S�bastien Guyon

See Also:

Preferences, PreferenceFactory.createPreferences(String, Class, String), ApplicationFrame.setPreferences(Preferences)

Field Summary

protected java.lang.String

DEFAULT_PREFERENCES_LOCATION Location for the default preferences.

Fields inherited from class com.tensegrity.gui.launch.LaunchTask

lasterror, LAUNCHTASKSTATUS_FATAL, LAUNCHTASKSTATUS_FATAL_RETRY, LAUNCHTASKSTATUS_SERIOUS, LAUNCHTASKSTATUS_SERIOUS_RETRY, LAUNCHTASKSTATUS_SHUTDOWN, LAUNCHTASKSTATUS_SUCCESS, LAUNCHTASKSTATUS_WARNING

Constructor Summary

SwtLoadPreferencesLaunchTask(ApplicationFrame applicationFrame)
Constructor specifying the ApplicationFrame to use.

SwtLoadPreferencesLaunchTask(ApplicationFrame applicationFrame, java.lang.String filename, java.lang.Class loadClass, java.lang.String defaultPreferences)
Creates the LoadRulesLaunchTask based on the given filename and Class to load the file.

Method Summary

protected java.lang.String	getDefaultPreferences() Returns the name of the file with all the default preferences.
protected java.lang.String	getFilename() Returns the name of the preferences file.
protected java.lang.Class	getLoadClass() When loading resource from jar files or other locations you may need a Class instance.
void	postCreate(java.lang.Object object) This method is invoked once the run() method is about to return.
int	run() The run method of this launch task.
protected void	setPreferenceHelper() This routine sets the preference helper on the application frame.

Methods inherited from class com.tensegrity.skeleton.launch.LoadFileLaunchTask

getName

Methods inherited from class com.tensegrity.skeleton.swing.launch.AbstractLaunchTask

findResourceText, getApplicationFrame, getStatusPrefix, getStatusPrefixResourceKey

Methods inherited from class com.tensegrity.gui.launch.LaunchTask

getError, getStatusDetails

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PREFERENCES_LOCATION

protected final java.lang.String DEFAULT_PREFERENCES_LOCATION

Location for the default preferences. Either use the custom constructor or overload the getDefaultPreferences() method to specify a different location.

See Also:

Constant Field Values

Constructor Detail

SwtLoadPreferencesLaunchTask

public SwtLoadPreferencesLaunchTask(ApplicationFrame applicationFrame)

Constructor specifying the ApplicationFrame to use.

Parameters:

applicationFrame - the ApplicationFrame to use.

SwtLoadPreferencesLaunchTask

public SwtLoadPreferencesLaunchTask(ApplicationFrame applicationFrame,
                                    java.lang.String filename,
                                    java.lang.Class loadClass,
                                    java.lang.String defaultPreferences)

Creates the LoadRulesLaunchTask based on the given filename and Class to load the file. Furthermore you can provide the location for the default preferences file.

Parameters:

applicationFrame - Application context for this LaunchTask.

filename - a String which describes a filename.

loadClass - the resource class to use for loading.

defaultPreferences - location of the default preferences file

Method Detail

getFilename

protected java.lang.String getFilename()

Returns the name of the preferences file.

Overrides:

getFilename in class LoadFileLaunchTask

Returns:

the name of the preferences file

See Also:

LoadFileLaunchTask.getFilename()

getDefaultPreferences

protected java.lang.String getDefaultPreferences()

Returns the name of the file with all the default preferences.

Returns:

the name of the file with all the default preferences

getLoadClass

protected java.lang.Class getLoadClass()

Description copied from class: LoadFileLaunchTask

When loading resource from jar files or other locations you may need a Class instance. Return null to load from absolute file.

Overrides:

getLoadClass in class LoadFileLaunchTask

Returns:

Class the class to use as resource loader.

postCreate

public void postCreate(java.lang.Object object)

This method is invoked once the run() method is about to return. The parameter is the Preferences initialized by this launch task.

Specified by:

postCreate in class AbstractLaunchTask

Parameters:

object - the Preferences initialized by this launch task.

See Also:

AbstractLaunchTask.postCreate(Object)

run

public final int run()
              throws java.lang.Exception

Description copied from class: LaunchTask

The run method of this launch task. The returned status indicates what the invoker is supposed to do after the task executed.

Specified by:

run in class LaunchTask

Returns:

one of the LAUNCHTASKSTATUS_* constants defined in this interface.

Throws:

java.lang.Exception

setPreferenceHelper

protected void setPreferenceHelper()

This routine sets the preference helper on the application frame.

See Also:

SwtPreferenceHelper