xdev

Class Application

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

java.applet.Applet

javax.swing.JApplet

xdev.Application

All Implemented Interfaces:

AppletStub, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, XdevApplicationContainer, XdevRootPaneContainer

public final class Application
extends JApplet
implements AppletStub, XdevApplicationContainer

This is the entry point of the XDEV Application Framework.

Desktop and webstart applications are started via the main(String[]) method, applets per default via init() and start().

The user application on top of the framework is started afterwards. This is because runtime environment specific init routines of the framwork are performed in this class.

The system or program parameter 'main' is used to define the user application's main class. Ensure that this main class is in a package, not in the default package.

Desktop application:

java [vm args] -Dmain=myapp.Start xdev.Application [application args]

Applet:

<applet code="xdev.Application.class">
<param name="main" value="myapp.Start" />
<param...
</applet>

Webstart:

<jnlp...
...
<resources>
<property name="application.type" value="webstart" />
<property name="main" value="start.Main" />
<property...
</resources>
...
<application-desc main-class="xdev.Application">
<argument...
</application-desc>
...
</jnlp>

Since:

3.0

Author:

XDEV Software

See Also:

main(String[]), initApplication(String[]), startApplication(), isApplet(), isApplication(), isWebstart(), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Application.State

Nested classes/interfaces inherited from class javax.swing.JApplet

JApplet.AccessibleJApplet

Nested classes/interfaces inherited from class java.applet.Applet

Applet.AccessibleApplet

Nested classes/interfaces inherited from class java.awt.Panel

Panel.AccessibleAWTPanel

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface xdev.ui.XdevRootPaneContainer

XdevRootPaneContainer.Util

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPLET Application type constant.
static int	APPLICATION Application type constant.
static int	WEBSTART Application type constant.

Fields inherited from class javax.swing.JApplet

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface xdev.ui.XdevRootPaneContainer

ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, NORMAL

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
Application()

Method Summary

Modifier and Type	Method and Description
static void	addExitListener(ApplicationExitListener l) Registers an ApplicationExitListener to obsorve the exit of this Application.
void	addWindowListener(WindowListener listener) Implemented with no action for XdevApplicationContainer.
void	appletResize(int width, int height)
void	close() Closes this container and releases all used resources.
void	destroy()
static void	exit(Object source) Exits the current running XDEV Application Framwork and Java Virtual Machine.
static void	gc() Runs the garbage collector.
static String[]	getArguments() Return the arguments handed over to the application in main(String[]).
static XdevApplicationContainer	getContainer() Returns the applications top level container.
int	getExtendedState() Implemented with no action for XdevApplicationContainer.
static Extension	getExtension(String name) Returns the extension named name or null if not found.
static Extension[]	getExtensions() Returns all available extensions.
static Image	getIconImage()
Image	getImage(URL url) Returns an Image object that can then be painted on the screen.
static GraphicsConfiguration	getLocalGraphicsConfiguration() Returns the default GraphicsConfiguration associated with the GraphicsDevice this application is showing on.
static XdevLogger	getLogger() Returns the XdevLogger of this Application which is used to log messages for the XDEV Application Framework.
static String	getParam(String name) Returns the value of the named parameter in the HTML tag.
static XdevDate	getServerTime() Returns the time of the hosting server of this applet / webstart application.
static Application.State	getState()
static int	getType()
Window	getWindow() Returns the Window of this XdevRootPaneContainer.
XdevWindow	getXdevWindow() Returns the internal XdevWindow of this XdevRootPaneContainer.
void	init()
static void	initApplication(String[] args) Initializes the XDEV Application Framework.
static boolean	isApplet()
static boolean	isApplication()
static boolean	isWebstart()
static void	main(String[] args) This is the entry point of the XDEV Application Framwork for desktop and webstart appications.
void	pack() Implemented with no action for XdevApplicationContainer.
static void	removeExitListener(ApplicationExitListener l) Removes the ApplicationExitListener l from this Application.
void	removeWindowListener(WindowListener listener) Implemented with no action for XdevApplicationContainer.
void	setExtendedState(int extendedState) Implemented with no action for XdevApplicationContainer.
void	setIconImage(Image img) Implemented with no action for XdevApplicationContainer.
void	setLocationRelativeTo(Component c) Implemented with no action for XdevApplicationContainer.
void	setResizable(boolean b) Implemented with no action for XdevApplicationContainer.
void	setTitle(String title) Sets the title of this XdevRootPaneContainer.
void	setXdevWindow(XdevWindow window) Sets the content of this XdevRootPaneContainer.
void	showDocument(URL url) Requests that the application container shows the Web page indicated by the url argument.
void	showDocument(URL url, String target) Requests that the application container shows the Web page indicated by the url argument.
void	start()
static void	startApplication() Starts the application after the XDEV application framwork has been initialized.
void	toBack() Implemented with no action for XdevApplicationContainer.
void	toFront() Implemented with no action for XdevApplicationContainer.

Methods inherited from class javax.swing.JApplet

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.applet.Applet

getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getLocale, getParameter, getParameterInfo, isActive, isValidateRoot, newAudioClip, play, play, resize, resize, setStub, showStatus, stop

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.applet.AppletStub

getAppletContext, getCodeBase, getDocumentBase, getParameter, isActive

Methods inherited from interface xdev.ui.XdevApplicationContainer

getCodeBase, getFontMetrics, getGraphics, getGraphicsConfiguration, getToolkit

Methods inherited from interface xdev.ui.XdevRootPaneContainer

getBounds, getLocation, getSize, setBounds, setLocation, setVisible

Methods inherited from interface javax.swing.RootPaneContainer

getContentPane, getGlassPane, getLayeredPane, getRootPane, setContentPane, setGlassPane, setLayeredPane

Field Detail

APPLICATION

public static final int APPLICATION

Application type constant.

See Also:

Constant Field Values

APPLET

public static final int APPLET

Application type constant.

See Also:

Constant Field Values

WEBSTART

public static final int WEBSTART

Application type constant.

See Also:

Constant Field Values

Constructor Detail

Application

public Application()

Method Detail

getType

public static int getType()

Returns:

The application's type. Either APPLICATION, APPLET or WEBSTART

isApplication

public static boolean isApplication()

Returns:

true if this is a desktop application started via main(String[]), false otherwise

isApplet

public static boolean isApplet()

Returns:

true if this is a applet running in a browser or another applet container, false otherwise

isWebstart

public static boolean isWebstart()

Returns:

true if this is a webstart application started via a webstart descriptor, false otherwise

getExtension

public static Extension getExtension(String name)

Returns the extension named name or null if not found.

Note: The extensions are only available after init() has been called.

Parameters:

name - the extension's name

Returns:

the appropriate extension or null

getExtensions

public static Extension[] getExtensions()

Returns all available extensions.

Note: The extensions are only available after init() has been called.

Returns:

All available extensions.

main

public static void main(String[] args)

This is the entry point of the XDEV Application Framwork for desktop and webstart appications.

It initializes the framework and starts the application based on the framework.

First initApplication(String[]) is called, then startApplication().

Hint: Can be used to start XdevWindows. Therefore set the VM Argument -Dmain=FULL_QUALIFIED_CLASSNAME. Where FULL_QUALIFIED_CLASSNAME is the full qualified classname like xdev.ui.MyClass.

Parameters:

args - The application's arguments

initApplication

public static void initApplication(String[] args)

Initializes the XDEV Application Framework.

• Determines whether this is a desktop or a webstart application
• Sets the look and feel to the system's default
• Evaluates the application's arguments args
• Initializes the applications top level container: a frame, a fullscreen window if the system property fullscreen is true or an applet

This method is called by main(String[]).

If you want to start your application without using main(String[]) of this class, call initApplication(String[]) at the beginning of your application to initialize the XDEV Application Framwork properly.

Parameters:

args - The application's arguments

startApplication

public static void startApplication()
                             throws IllegalStateException

Starts the application after the XDEV application framwork has been initialized.

This method is called by main(String[]) after initApplication(String[]).

The system property main is used to determine the main class.

• If the class has a valid main method, it is called with the arguments handed over in initApplication(String[]).
• If the class is an instance of XdevWindow it is initialized via the default constructor and shown in the application's top level container.
• If the class is an instance of JComponent it is initialized via the default constructor, placed in a XdevWindow and shown in the application's top level container.

Throws:

IllegalStateException - if the framework has not been initialized via initApplication(String[])

See Also:

main(String[]), initApplication(String[])

getArguments

public static String[] getArguments()
                             throws IllegalStateException

Return the arguments handed over to the application in main(String[]).

Returns:

The application's arguments

Throws:

IllegalStateException - if this Application is an Applet

See Also:

getType()

getParam

public static String getParam(String name)
                       throws IllegalStateException

Returns the value of the named parameter in the HTML tag. For example, if this applet is specified as

 
 
 
 
 
 then a call to getParameter("Color") returns the value "blue".
 

 The name argument is case insensitive.
 

Parameters:
name - a parameter name.
Returns:
the value of the named parameter, or null if not set.
Throws:
IllegalStateException - if this Application is not an Applet
See Also:
getType()








getIconImage
public static Image getIconImage()







getContainer
public static XdevApplicationContainer getContainer()
Returns the applications top level container.
 

 It is either a frame, a fullscreen window or an applet.

Returns:
The application's top level container








getState
public static Application.State getState()

Returns:
the application's current state
Since:
4.0








addExitListener
public static void addExitListener(ApplicationExitListener l)
Registers an ApplicationExitListener to obsorve the exit of this
 Application.

Parameters:
l - the listener to add








removeExitListener
public static void removeExitListener(ApplicationExitListener l)
Removes the ApplicationExitListener l from this
 Application.

Parameters:
l - the listener to remove








exit
public static void exit(Object source)
Exits the current running XDEV Application Framwork and Java Virtual
 Machine.
 

 If a registered ApplicationExitListener vetos the process, the
 exit is terminated and the XDEV Application Framework remains running.

Parameters:
source - The initiator of the exit process
See Also:
ApplicationExitListener, 
ApplicationExitEvent.vetoExit()








getServerTime
public static XdevDate getServerTime()
Returns the time of the hosting server of this applet / webstart
 application.

Returns:
The server time of this application.








gc
public static void gc()
Runs the garbage collector.
 

 Calling the gc method suggests that the Java Virtual Machine expend
 effort toward recycling unused objects in order to make the memory they
 currently occupy available for quick reuse. When control returns from the
 method call, the Java Virtual Machine has made a best effort to reclaim
 space from all discarded objects.
 







getLocalGraphicsConfiguration
public static GraphicsConfiguration getLocalGraphicsConfiguration()
Returns the default GraphicsConfiguration associated with the
 GraphicsDevice this application is showing on.

Returns:
the default GraphicsConfiguration of this
         GraphicsDevice.








init
public void init()

Overrides:
init in class Applet








start
public void start()

Overrides:
start in class Applet








destroy
public void destroy()

Overrides:
destroy in class Applet








getWindow
public Window getWindow()
Returns the Window of this XdevRootPaneContainer.

Specified by:
getWindow in interface XdevRootPaneContainer
Returns:
the Window of this XdevRootPaneContainer








getImage
public Image getImage(URL url)
Returns an Image object that can then be painted on the
 screen. The url that is passed as an argument must specify
 an absolute URL.
 

 This method always returns immediately, whether or not the image exists.
 When this XdevApplicationContainer attempts to draw the image on the
 screen, the data will be loaded. The graphics primitives that draw the
 image will incrementally paint on the screen.

Specified by:
getImage in interface XdevApplicationContainer
Overrides:
getImage in class Applet
Parameters:
url - an absolute URL giving the location of the image.
Returns:
the image at the specified URL.
See Also:
Image








showDocument
public void showDocument(URL url)
Requests that the application container shows the Web page indicated by
 the url argument. The browser or applet viewer determines
 which window or frame to display the Web page.

Specified by:
showDocument in interface XdevApplicationContainer
Parameters:
url - an absolute URL giving the location of the document.








showDocument
public void showDocument(URL url,
                         String target)
Requests that the application container shows the Web page indicated by
 the url argument. The target argument indicates
 in which HTML frame the document is to be displayed. The target argument
 is interpreted as follows:
 

 
 

 

 
Target Argument
 
Description
 
 

 
"_self"
 
Show in the window and frame that contain the applet.
 
 

 
"_parent"
 
Show in the applet's parent frame. If the applet's frame has no
 parent frame, acts the same as "_self".
 
 

 
"_top"
 
Show in the top-level frame of the applet's window. If the applet's
 frame is the top-level frame, acts the same as "_self".
 
 

 
"_blank"
 
Show in a new, unnamed top-level window.
 
 

 
name
 
Show in the frame or window named name. If a target named
 name does not already exist, a new top-level window with the
 specified name is created, and the document is shown there.
 
 
 
 
 

 An applet viewer or browser is free to ignore this method.

Specified by:
showDocument in interface XdevApplicationContainer
Parameters:
url - an absolute URL giving the location of the document.
target - a String indicating where to display the page.








appletResize
public void appletResize(int width,
                         int height)

Specified by:
appletResize in interface AppletStub








setXdevWindow
public void setXdevWindow(XdevWindow window)
Sets the content of this XdevRootPaneContainer.

Specified by:
setXdevWindow in interface XdevRootPaneContainer
Parameters:
window - the XdevWindow for this XdevRootPaneContainer








getXdevWindow
public XdevWindow getXdevWindow()
Returns the internal XdevWindow of this
 XdevRootPaneContainer.

Specified by:
getXdevWindow in interface XdevRootPaneContainer
Returns:
the internal XdevWindow








setTitle
public void setTitle(String title)
Sets the title of this XdevRootPaneContainer.

Specified by:
setTitle in interface XdevRootPaneContainer
Parameters:
title - the title to be displayed








setIconImage
public void setIconImage(Image img)
Implemented with no action for XdevApplicationContainer.

Specified by:
setIconImage in interface XdevApplicationContainer
Parameters:
img - the image to be displayed








pack
public void pack()
Implemented with no action for XdevApplicationContainer.

Specified by:
pack in interface XdevRootPaneContainer
See Also:
Component.isDisplayable()








setLocationRelativeTo
public void setLocationRelativeTo(Component c)
Implemented with no action for XdevApplicationContainer.

Specified by:
setLocationRelativeTo in interface XdevRootPaneContainer
Parameters:
c - the component in relation to which the
            XdevRootPaneContainer location is determined








setResizable
public void setResizable(boolean b)
Implemented with no action for XdevApplicationContainer.

Specified by:
setResizable in interface XdevRootPaneContainer
Parameters:
b - true if the user can resize this
            XdevRootPaneContainer; false otherwise.








setExtendedState
public void setExtendedState(int extendedState)
Implemented with no action for XdevApplicationContainer.

Specified by:
setExtendedState in interface XdevRootPaneContainer
Parameters:
extendedState - a bitwise mask of frame state constants
See Also:
XdevRootPaneContainer.getExtendedState(), 
Toolkit.isFrameStateSupported(int)








getExtendedState
public int getExtendedState()
Implemented with no action for XdevApplicationContainer.

Specified by:
getExtendedState in interface XdevRootPaneContainer
Returns:
a bitwise mask of frame state constants
See Also:
XdevRootPaneContainer.setExtendedState(int)








toFront
public void toFront()
Implemented with no action for XdevApplicationContainer.

Specified by:
toFront in interface XdevRootPaneContainer
See Also:
XdevRootPaneContainer.toBack()








toBack
public void toBack()
Implemented with no action for XdevApplicationContainer.

Specified by:
toBack in interface XdevRootPaneContainer
See Also:
XdevRootPaneContainer.toFront()








addWindowListener
public void addWindowListener(WindowListener listener)
Implemented with no action for XdevApplicationContainer.

Specified by:
addWindowListener in interface XdevRootPaneContainer
Parameters:
listener - the window listener








removeWindowListener
public void removeWindowListener(WindowListener listener)
Implemented with no action for XdevApplicationContainer.

Specified by:
removeWindowListener in interface XdevRootPaneContainer
Parameters:
listener - the window listener








close
public void close()
Closes this container and releases all used resources.

Specified by:
close in interface XdevRootPaneContainer








getLogger
public static XdevLogger getLogger()
Returns the XdevLogger of this Application which is used to log
 messages for the XDEV Application Framework.
 
 
 

 Hint: Consider using local loggers instead of using one
 application global logger. With local loggers you benefit from many
 advantages i.e. name based filtering and message routing.
 
 

Returns:
the XdevLogger of this Application.














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2003–2022 XDEV Software. All rights reserved.