net.xoetrope.xui
Interface XStartupObject

All Known Implementing Classes:

XApplet, XApplet, XApplet, XDesktopApp, XDockingApp, XuiProxy

public interface XStartupObject

A interface to the startup object

Copyright: Copyright (c) Xoetrope Ltd., 1998-2005
License: see license.txt

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 application menubar
java.lang.Object	getContentPaneEx() Get the content pane used by XUI - the container in which pages are displayed
java.net.URL	getDocumentBase() Gets the URL of the document in which this applet is embedded.
java.lang.String	getParameter(java.lang.String param) Get a startup parameter
java.lang.Object	getParentObject() Get the parent container/object
java.lang.String	getWidgetClassPackage() Get the package name for the default widget set
void	refresh() Validate and repaint the display
void	restoreViews() Restore the normal page views, as in the case of the docking layout where panels may be zoomed or minimized.
void	setApplicationMenuBar(java.lang.Object mb) Set the menubar
void	setAppTitle(java.lang.String title) Set the application title.
void	setIcon(java.awt.Image img) Set the application icon
void	setSize(java.awt.Dimension size) Set the size of this application/applet
void	setupFrameset(java.util.Hashtable params) Setup frameset.
void	setupWindow(XApplicationContext context, XProject currentProject, int clientWidth, int clientHeight) Setup the main application window
void	validate() Validates this container and all of its subcomponents

Method Detail

getParameter

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

Get a startup parameter

Parameters:

param - the name of the parameter

getWidgetClassPackage

java.lang.String getWidgetClassPackage()

Get the package name for the default widget set

Returns:

the class name of the widget set

getParentObject

java.lang.Object getParentObject()

Get the parent container/object

Returns:

the parent

getDocumentBase

java.net.URL getDocumentBase()

Gets the URL of the document in which this applet is embedded. For example, suppose an applet is contained within the document:

    http://java.sun.com/products/jdk/1.2/index.html
 

The document base is:

    http://java.sun.com/products/jdk/1.2/index.html
 

Returns:

the URL of the document that contains this applet.

See Also:

Applet.getCodeBase()

setSize

void setSize(java.awt.Dimension size)

Set the size of this application/applet

Parameters:

size - the requested size

getContentPaneEx

java.lang.Object getContentPaneEx()

Get the content pane used by XUI - the container in which pages are displayed

Returns:

the page container

validate

void validate()

Validates this container and all of its subcomponents

refresh

void refresh()

Validate and repaint the display

setAppTitle

void setAppTitle(java.lang.String title)

Set the application title. This method is called just before the first page is displayed, when all the other resources should have been loaded.

Parameters:

title -

setIcon

void setIcon(java.awt.Image img)

Set the application icon

Parameters:

img - the image name

setupWindow

void setupWindow(XApplicationContext context,
                 XProject currentProject,
                 int clientWidth,
                 int clientHeight)

Setup the main application window

Parameters:

context - the application context for the new application

currentProject - the current project

clientWidth - the desired width for the new window

clientHeight - the desired height for the new window

setupFrameset

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

Parameters:

params - the framset parameters if any

displayDecoration

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

Display a window decoration, for example a toolbar

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

getApplicationMenuBar

java.lang.Object getApplicationMenuBar()

Get the application menubar

Returns:

the menu bar

setApplicationMenuBar

void setApplicationMenuBar(java.lang.Object mb)

Set the menubar

Parameters:

mb - the menubar

restoreViews

void restoreViews()

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