com.tensegrity.skeleton.swt.launch
Class SwtInitGUILaunchTask

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

public class SwtInitGUILaunchTask

extends AbstractLaunchTask

This launch task initializes the GUI for a given SwtApplicationFrame, which means that it sets the positions of the ToolBar, MDIComponent and of all the Containers used within the SwtApplicationFrame passed to the constructor.

Application developers willing to change the default organization of all these GUI items on the application Shell should override the following methods:

• getApplicationShellLayout()
• setToolBarLayoutData(SwtToolBar)
• setMDIComponentLayoutData(SwtTabbedMDIComponent)
• setContainerLayoutData(AbstractSwtToolContainer)

Notice that a good understanding of layouts in SWT is required in order to modify the default layout. Refer to http://www.eclipse.org/articles/Understanding%20Layouts/Understanding%20Layouts.htm for more information regarding layouts in SWT.

Version:

$Id: SwtInitGUILaunchTask.java,v 1.9 2005/08/08 16:36:36 BurkhardWick Exp $

Author:

S�bastien Guyon

Field Summary

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

SwtInitGUILaunchTask(SwtApplicationFrame applicationFrame)
Creates the SwtInitGUILaunchTask which initializes the GUI for a given SwtApplicationFrame.

Method Summary

protected org.eclipse.swt.widgets.Layout	getApplicationShellLayout() This method returns the Layout to be set on the Shell where the application is displayed.
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	setContainerLayoutData(AbstractSwtToolContainer container) Subclasses can override this routine in order to change the layout data of the application's swt containers.
protected void	setMDIComponentLayoutData(SwtTabbedMDIComponent mdi) Subclasses can override this routine in order to change the layout data of the application'S MDI component.
protected void	setToolBarLayoutData(SwtToolBar toolbar) Subclasses can override this routine in order to change the layout data of the application's SwtToolBar.

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

findResourceText, getApplicationFrame, getName, 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

Constructor Detail

SwtInitGUILaunchTask

public SwtInitGUILaunchTask(SwtApplicationFrame applicationFrame)

Creates the SwtInitGUILaunchTask which initializes the GUI for a given SwtApplicationFrame.

Parameters:

applicationFrame - Application context for this LaunchTask.

Method Detail

run

public 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

postCreate

public void postCreate(java.lang.Object object)

This method is invoked once the run() method is about to return. The parameter is the SwtApplicationFrame .

Specified by:

postCreate in class AbstractLaunchTask

Parameters:

object - the SwtApplicationFrame.

See Also:

AbstractLaunchTask.postCreate(Object)

setToolBarLayoutData

protected void setToolBarLayoutData(SwtToolBar toolbar)

Subclasses can override this routine in order to change the layout data of the application's SwtToolBar.
Important: The layout data set within this routine must be compatible with the layout returned by getApplicationShellLayout().

Parameters:

toolbar - the application's SwtToolBar.

See Also:

getApplicationShellLayout()

setContainerLayoutData

protected void setContainerLayoutData(AbstractSwtToolContainer container)

Subclasses can override this routine in order to change the layout data of the application's swt containers.
Important: The layout data set within this routine must be compatible with the layout returned by getApplicationShellLayout().

Parameters:

container - an AbstractSwtToolContainer to which the layout data is to be set.

setMDIComponentLayoutData

protected void setMDIComponentLayoutData(SwtTabbedMDIComponent mdi)

Subclasses can override this routine in order to change the layout data of the application'S MDI component.
Important: The layout data set within this routine must be compatible with the layout returned by getApplicationShellLayout().

Parameters:

mdi - the SwtTabbedMDIComponent

getApplicationShellLayout

protected org.eclipse.swt.widgets.Layout getApplicationShellLayout()

This method returns the Layout to be set on the Shell where the application is displayed. The default implementation returns a FormLayout instance.

Returns:

the Layout to be set on the application's Shell (a FormLayout by default).