org.formaria.swt
Class Applet

java.lang.Object
  Composite
      org.formaria.swt.Applet

All Implemented Interfaces:

PersistentState, StartupObject

public class Applet
extends Composite
implements StartupObject

This class is constructed with a window or frame and can be part of an applet or an application. The class acts as the main entry point to an Aria application and provides some of the infrastructure needed to support the application.

The applet can provide support for a frameset or a single page. Page display functions are also supported to allow the application to display more than a single page or change the page that is displayed.

By choosing either the AWT or Swing version of the Applet you choose to have either an AWT or a Swing application/applet. In general once this choice has been made you should not mix toolkits.

Copyright (c) Formaria Ltd.,
License: see license.txt

Field Summary

protected ApplicationContext	applicationContext
protected Shell	clientShell
protected Display	display

Constructor Summary

Applet()
A default constructor.

Applet(java.lang.String[] args, Shell f, Display d)
Create a new application.

Method Summary

java.lang.Object	displayDecoration(PageSupport page, java.lang.String constraint) Display a window decoration, for example a toolbar
java.lang.Object	getApplicationMenuBar() Get the menubar, setting it up if it is not already added to the application frame
java.lang.Object	getContentPaneEx() Get the panel which has the content
java.net.URL	getDocumentBase() Gets of the document
java.lang.Object	getFrame() Gets the Frame containing the applet.
java.lang.String	getParameter(java.lang.String param) Get a startup parameter
java.lang.Object	getParentObject() Get the parent object
java.lang.String	getWidgetClassPackage() Get the package name for the default widget set
void	init() Invoked when used as an applet.
static void	main(java.lang.String[] args) main method to be invoked as an application.
void	refresh() Refresh the parent shell
void	restoreState(XmlElement stateElement) Restore the application state
void	restoreViews() Restore the normal page views, as in the case of the docking layout where panels may be zoomed or minimized.
void	saveState(XmlElement stateElement) Save the application state
void	setApplicationMenuBar(java.lang.Object mb) Set the menubar
void	setAppTitle(java.lang.String title) Set the title to the parent shell
void	setIcon(java.awt.Image icon) Set the icon to the parent shell
void	setSize(java.awt.Dimension size) Sets the size to the shell
void	setupFrameset(java.util.Hashtable params) Setup frameset.
void	setupWindow(ApplicationContext context, Project currentProject, int clientWidth, int clientHeight) Setup the windowing.
void	validate() Validates the Applet

Methods inherited from class java.lang.Object

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

Field Detail

clientShell

protected Shell clientShell

display

protected Display display

applicationContext

protected ApplicationContext applicationContext

Constructor Detail

Applet

public Applet()

A default constructor. Most of the setup work is actually done by the initialize method and is called by the main method or the init method depending on whether or not an application of applet is being launched.

Applet

public Applet(java.lang.String[] args,
              Shell f,
              Display d)

Create a new application. Most of the setup work is actually done by the initialize method and is called by the main method or the init method depending on whether or not an application of applet is being launched.

Parameters:

args - the application command-line arguments

f - the parent shell

d - the parent display

Method Detail

main

public static void main(java.lang.String[] args)

main method to be invoked as an application. This method is invoked as the entry point to the 'Application', it is not used if an Applet is being launched. This method establishes the frame within which the application runs. If overloading this method remeber to call the setup method.

Parameters:

args - the command line arguments

getParentObject

public java.lang.Object getParentObject()

Get the parent object

Specified by:

getParentObject in interface StartupObject

Returns:

the parent

getWidgetClassPackage

public java.lang.String getWidgetClassPackage()

Get the package name for the default widget set

Specified by:

getWidgetClassPackage in interface StartupObject

Returns:

the class name of the widget set

setupFrameset

public void setupFrameset(java.util.Hashtable params)

Setup frameset. This method is called prior to the addition of any target areas in the framset and prior to the display of any pages. Since this applet does not support configurable framesets, this method ignores the parameter values passed.

Specified by:

setupFrameset in interface StartupObject

Parameters:

params - the framset parameters if any

displayDecoration

public java.lang.Object displayDecoration(PageSupport page,
                                          java.lang.String constraint)

Display a window decoration, for example a toolbar

Specified by:

displayDecoration in interface StartupObject

Parameters:

page - the new page

constraint - a value controlling how and where the decoration is displayed, this value is application type specific

Returns:

the page being displayed

refresh

public void refresh()

Refresh the parent shell

Specified by:

refresh in interface StartupObject

restoreViews

public void restoreViews()

Restore the normal page views, as in the case of the docking layout where panels may be zoomed or minimized. The method is called prior to the display of a new page.

In this context the method has no effect.

Specified by:

restoreViews in interface StartupObject

getContentPaneEx

public java.lang.Object getContentPaneEx()

Get the panel which has the content

Specified by:

getContentPaneEx in interface StartupObject

Returns:

the page container

setAppTitle

public void setAppTitle(java.lang.String title)

Set the title to the parent shell

Specified by:

setAppTitle in interface StartupObject

setIcon

public void setIcon(java.awt.Image icon)

Set the icon to the parent shell

Specified by:

setIcon in interface StartupObject

Parameters:

icon - the image name

setupWindow

public void setupWindow(ApplicationContext context,
                        Project currentProject,
                        int clientWidth,
                        int clientHeight)

Setup the windowing.

Specified by:

setupWindow in interface StartupObject

Parameters:

context - the owner application context

currentProject - the owner project

clientWidth - the desired width of the application

clientHeight - the desired height of the application

init

public void init()

Invoked when used as an applet. Sets up the startup file and initialises the application. Reads the applet parameters and calls initialize.

getFrame

public java.lang.Object getFrame()

Gets the Frame containing the applet.

Returns:

Frame which is the applet or application's parent

validate

public void validate()

Validates the Applet

Specified by:

validate in interface StartupObject

setSize

public void setSize(java.awt.Dimension size)

Sets the size to the shell

Specified by:

setSize in interface StartupObject

Parameters:

size - size of the shell

getDocumentBase

public java.net.URL getDocumentBase()

Gets of the document

Specified by:

getDocumentBase in interface StartupObject

Returns:

the URL of the document that contains this applet.

See Also:

Applet.getCodeBase()

getParameter

public java.lang.String getParameter(java.lang.String param)

Get a startup parameter

Specified by:

getParameter in interface StartupObject

Parameters:

param - the name of the parameter

getApplicationMenuBar

public java.lang.Object getApplicationMenuBar()

Get the menubar, setting it up if it is not already added to the application frame

Specified by:

getApplicationMenuBar in interface StartupObject

Returns:

the menu bar

setApplicationMenuBar

public void setApplicationMenuBar(java.lang.Object mb)

Set the menubar

Specified by:

setApplicationMenuBar in interface StartupObject

Parameters:

mb - the menubar

restoreState

public void restoreState(XmlElement stateElement)

Restore the application state

Specified by:

restoreState in interface PersistentState

saveState

public void saveState(XmlElement stateElement)

Save the application state

Specified by:

saveState in interface PersistentState

Parameters:

the - elements to hold the page state