net.xoetrope.swt
Class XApplet

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  net.xoetrope.swt.XApplet

All Implemented Interfaces:

XPageDisplay, org.eclipse.swt.graphics.Drawable

public class XApplet

extends org.eclipse.swt.widgets.Composite

implements XPageDisplay

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 XUI 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 XApplet 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) Xoetrope Ltd., 1998-2004
License: see license.txt

clientShell

protected static org.eclipse.swt.widgets.Shell clientShell

display

protected static org.eclipse.swt.widgets.Display display

pageMgr

protected XPageManager pageMgr

modelDataSource

protected XDataSource modelDataSource

defaultSourceClass

protected static java.lang.Class defaultSourceClass

clientWidth

protected int clientWidth

clientHeight

protected int clientHeight

XApplet

public XApplet()

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.

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.

setup

protected void setup(java.lang.String[] args)

Setup the applet by setting paths and then initializing the applet. This method is a stand-in for the main method, processing the commandline parameters, so that its work is reusable and does not needed to be redone by derived classes. This method should not be called directly by user code.

Parameters:

args - the command line arguments

getSecondaryClassLoader

protected XPageLoader getSecondaryClassLoader(java.lang.String packageName)

Construct a new builder and set the default package. XUI sometimes uses additional class loaders to find the resources needed in a project. By default XUI uses the XuiBuilder class loader to convert XML files to Java classes.

A custom class loader can be referenced in the startup properties file using the 'BuilderClass' property. Once this property has been determined this method will instantiate an instance of that class if necessary.

Parameters:

packageName - the name of the default widget package e.g. net.xoetrope.awt, this is normally defined as a result of choosing the appropriate version of the XApplet class

setDefaultDataSource

public void setDefaultDataSource(java.lang.String className)

Sets the default datasource class. The default data source will be used to provide any initial data for the XModel. Normally this data is static data that will be used to populate things like lists and provide default values.

Parameters:

className - the name of the datasource class e.g. net.xoetrope.data.XDataSource.class, this class reads data from an XML file

setResourceFile

protected void setResourceFile(java.lang.String startFile)

Setup the default resource file for the application and load some of the information in it. The resource file is the startup properties file

Parameters:

startFile - The name of the file to be loaded, by default startup.properties

getFrame

public org.eclipse.swt.widgets.Display getFrame()

Gets the Frame containing the applet.

Returns:

Frame which is the applet or application's parent

initialise

protected void initialise(org.eclipse.swt.widgets.Shell s)

Generic function which is called from the constructor if it's an application or from start if its an applet.

The initialization process proceeds in the following order

1. Register the component factories
2. Setup the project class
3. Setup the page manager
4. Setup the resource manager
5. Setup the style manager
6. Size the main window
7. Set the layout
8. Add a shutdown hook
9. Display the main window

register

protected void register()

Load the componentFactories by reading the factory names from the startup file. The value of the 'NumComponentFactories' is first read and then the value of ComponentFactory (i.e. ComponentFactory0, ComponentFactory1) where is the number, starting at zero, of the factory. Each factory is then instantiated and will be called upon to construct components in the order in which the factories were registered.

setContent

protected void setContent(org.eclipse.swt.widgets.Shell s)

Load the content into the model. In the process an instance of the default model data source class is instantiated and reads data from a file pointed to by the 'ModelData' startup parameter.

setHome

public void setHome()

Set the home page using the startup properties. The home page is established by combining the two startup properties 'StartPackage' and 'StartClass'. By default 'StartClass' is set to a value of 'home. Both startup parameters are optional. Loads the first page for the application.

displayPage

public java.lang.Object displayPage(PageSupport page)

Called when a page has been added or shown via the XPageManager. The page manager then requests that the applet/application then displays the page in the appropriate location.

Specified by:

displayPage in interface XPageDisplay

Parameters:

page - The XPage which has been loaded.

Returns:

the page being displayed

displayPage

public java.lang.Object displayPage(PageSupport pageObj,
                                    java.lang.String target)

Called when a page has been added or shown via the XPageManager. The page manager then requests that the applet/application then displays the page in the appropriate location.

The sequence with which the page transition occurs is as follows:

• Find the appropriate target area
• Ask the page to make its components non visible (to avoid flicker during the page update)
• Set the page size
• Save the current page's data by calling 'saveBoundComponentValues
• Mark the current page as deactivated, and call the page's deactivated() method
• Remove the old page from the container
• Add the new page
• Update the new page's bindings by calling updateBindings()
• Update the new page's data by calling updateBoundComponentValues()
• Layout the container and request it to repaint
• Show the new page
• Mark the new page as activated, and call its pageActivated method
• Specified by:

  displayPage in interface XPageDisplay

  Parameters:

  pageObj - The XPage which has been loaded.

  target - the area to update

  Returns:

  the page being displayed

  ---

  hidePage

  public void hidePage(XSwtPage page)

  Remove the page from container. The page is simply removed and the container validated.

  Parameters:

  page -

  ---

  findTarget

  public java.lang.Object findTarget(java.lang.String target)

  Finds the target area for a page display request, this only applies to a frameset. If there is no frameset the main area or default area is named 'content' and this area is used if null is used as the target name.

  Specified by:

  findTarget in interface XPageDisplay

  Parameters:

  target - the target area name

  Returns:

  the container to be updated

  ---

  getTarget

  public java.lang.Object getTarget(int idx)

  Get the target for a page display request. The target areas are stored in the order in which they were declared or added.

  Specified by:

  getTarget in interface XPageDisplay

  Parameters:

  idx - the target area

  Returns:

  the container to be updated

  ---

  getNumTargets

  public int getNumTargets()

  Get the number of target areas in the container

  Specified by:

  getNumTargets in interface XPageDisplay

  Returns:

  the number of target frames

  ---

  addTarget

  public XContentHolder addTarget(java.lang.String name,
                                  java.lang.Object constraint,
                                  int preferredWidth,
                                  int preferredHeight,
                                  java.util.Hashtable params)

  Add a new frame or target area to a frameset

  Specified by:

  addTarget in interface XPageDisplay

  Parameters:

  name - the frame name

  constraint - the BorderlayoutConstraint

  preferredWidth - the preferred width

  preferredHeight - the preferred height

  params - extra parameters for the target

  Returns:

  the new target

  ---

  removeAllTargets

  public void removeAllTargets()

  Remove all frames/targets from the current frameset

  Specified by:

  removeAllTargets in interface XPageDisplay

  ---

  getClientWidth

  public int getClientWidth()

  Get the width of the main window.

  ---

  getClientHeight

  public int getClientHeight()

  Get the height of the main window.

  ---

  setMenuBar

  public static void setMenuBar(org.eclipse.swt.widgets.Menu mb)

  Set the menubar.

  Parameters:

  mb -

  ---

  getMenuBar

  public static org.eclipse.swt.widgets.Menu getMenuBar()

  Get the menubar.

  ---

  getDocumentBase

  public java.net.URL getDocumentBase()

  Template method, unused at present

  ---

  Overview  Package   Class  Use  Tree  Deprecated  Index  Help
  PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
  SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

  ---