de.must.applet

Class RGUIGlobal

java.lang.Object

de.must.middle.SuperGlobal

de.must.applet.RGUIGlobal

All Implemented Interfaces:

FrameworkTextResource, FrontendResources, ImageResource

public class RGUIGlobal
extends SuperGlobal
implements FrontendResources

Global stuff for remote GUI context.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RGUIGlobal.HTMLSource

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLET_VERSION_INFO
AppletDialog	currentDialog
Printer	currentPrinter
protected java.awt.Cursor	DefaultCursor
protected boolean	loggedOut
RemStructureOutlineFrame	outlineWindow
protected ParametersFromPropertyFiles	parametersFromPropertyFiles
java.util.Hashtable<java.lang.String,RemoteGUIComponent>	rgcs
int	secondsBeforeAutomaticLogout
RemListSelectionFrame	selectionWindow
RemServerProcessControllerFrame	serverProcessControllerFrame
java.lang.String	serverRGUIversion
java.lang.String	sessionId
static int	START_IMAGE_PRESENTED
static int	START_IMAGE_REPLACED
static int	START_IMAGE_TO_SHOW
java.util.Hashtable<java.lang.String,de.must.applet.RGUIGlobal.Task>	tasks
java.lang.String	tempFolderName
int	timeout
protected java.awt.Cursor	WaitCursor
protected java.util.Hashtable<java.lang.String,de.must.applet.RGUIGlobal.WinProp>	winBounds
java.util.Hashtable<java.lang.String,javax.swing.JFrame>	windows

Fields inherited from class de.must.middle.SuperGlobal

BUNDLE_NAME_DE, BUNDLE_NAME_DK, BUNDLE_NAME_EN, BUNDLE_NAME_ES, BUNDLE_NAME_FR, BUNDLE_NAME_IT, BUNDLE_NAME_NL, BUNDLE_NAME_TR, BUNDLE_NAME_ZH, DENMARK, NETHERLANDS, resourceBundles, SPAIN, TURKEY

Constructor Summary

Constructors

Constructor and Description
RGUIGlobal()

Method Summary

Modifier and Type	Method and Description
de.must.applet.RGUIGlobal.Veto	contactServer(KeyValuePairAlpha param) Contacts assigned server with parameters as specified.
de.must.applet.RGUIGlobal.Veto	contactServer(KeyValuePairAlpha param, boolean ownThread) Contacts assigned server with parameters as specified.
de.must.applet.RGUIGlobal.Veto	contactServer(java.util.Vector<KeyValuePairAlpha> params) Contacts assigned server with parameters as specified.
de.must.applet.RGUIGlobal.Veto	contactServer(java.util.Vector<KeyValuePairAlpha> params, boolean ownThread, boolean callEvenIfThreadIsPending) Contacts assigned server with parameters as specified.
void	contactServerInOwnThread(java.util.Vector<KeyValuePairAlpha> params) Contacts assigned server with parameters as specified using a new thread.
MustButton	createButton(java.lang.String imageName, java.lang.String defaultLabel)
MustButton	createButton(java.lang.String imageName, java.lang.String defaultLabel, java.lang.String tooltiptext, java.lang.String actionCommand, java.awt.event.ActionListener l)
boolean	download(java.lang.String inputPath, java.lang.String outputPath)
boolean	download(java.lang.String inputPath, java.lang.String outputPath, boolean override)
boolean	downloadFromURL(java.lang.String url, java.lang.String outputPath, boolean override)
java.applet.AppletContext	getAppletContext()
java.lang.String	getCodeBase()
java.lang.String	getFrameworkResourceString(java.lang.String resourceKey) Returns a package specific resource as a string.
java.lang.String	getIdString(Identifier[] identifiers)
java.lang.String	getIdString(java.util.Vector<Identifier> identifiers)
javax.swing.ImageIcon	getImageIcon(java.lang.String imageName) Returns an image loaded by name from typical images folder, e.g.
javax.swing.ImageIcon	getImageIconIndividual(java.lang.String imagePath) Returns image icons for path as specified - in opposite to getImageIcon, the image is searched absolutely respectively below current directory or the code base in case of applets.
java.io.InputStream	getInputStream(java.util.Vector<KeyValuePairAlpha> params)
static RGUIGlobal	getInstance()
javax.swing.JFrame	getMainWindow() Returns the main window of the application.
RemoteGUIComponent	getRemoteGUIComponent(java.lang.String id)
RGUI	getRGUI()
java.io.BufferedReader	getServerFileReader(java.lang.String relativeFilePath) Returns a buffered file reader to access a server file.
protected java.io.BufferedReader	getServerInputStream(java.util.Vector<KeyValuePairAlpha> params) Returns an input stream to receive server data for the parameters as specified.
java.lang.String	getServletName()
boolean	isServerCallThreadPending() Returns true if a server contact in an own thread is pending.
boolean	isURLavailable(java.lang.String url)
void	logout() Perform logout.
void	playSound(java.lang.String soundFileName)
void	register(java.lang.String id, RemoteGUIComponent remoteGUIComponent)
void	remove(AppletGUIs gui)
void	removeTask(java.lang.String title)
void	setAppletContext(java.applet.AppletContext appletContext)
void	setCodeBase(java.lang.String codeBase)
void	setLanguage(int language)
void	setProxy(java.lang.String proxyHost, int proxyPort, java.lang.String proxyUserName, java.lang.String proxyPassword) Sets proxy information - not for applet, but for application.
void	setRGUI(RGUI rgui)
void	setServletName(java.lang.String servletName)
void	setStatusLoggedOutToStopLogoutControl()
void	startLogoutControl(MustLabel infoLabel) Starts logout control.
boolean	upload(java.lang.String fileName, java.util.Vector<KeyValuePairAlpha> params, java.io.FileInputStream inputStream)

Methods inherited from class de.must.middle.SuperGlobal

getHomeDir, getResourceString, getResourceString, getSoundDirectory, getSuperInstance, getUserTempDir, getWorkingDir, getWorkingDirAbsolutPath, playSound, playSound, setHomeDir

Methods inherited from class java.lang.Object

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

Field Detail

APPLET_VERSION_INFO

public static final java.lang.String APPLET_VERSION_INFO

See Also:

Constant Field Values

START_IMAGE_TO_SHOW

public static final int START_IMAGE_TO_SHOW

See Also:

Constant Field Values

START_IMAGE_PRESENTED

public static final int START_IMAGE_PRESENTED

See Also:

Constant Field Values

START_IMAGE_REPLACED

public static final int START_IMAGE_REPLACED

See Also:

Constant Field Values

serverRGUIversion

public java.lang.String serverRGUIversion

secondsBeforeAutomaticLogout

public int secondsBeforeAutomaticLogout

tasks

public java.util.Hashtable<java.lang.String,de.must.applet.RGUIGlobal.Task> tasks

windows

public java.util.Hashtable<java.lang.String,javax.swing.JFrame> windows

currentDialog

public AppletDialog currentDialog

outlineWindow

public RemStructureOutlineFrame outlineWindow

selectionWindow

public RemListSelectionFrame selectionWindow

serverProcessControllerFrame

public RemServerProcessControllerFrame serverProcessControllerFrame

currentPrinter

public Printer currentPrinter

rgcs

public java.util.Hashtable<java.lang.String,RemoteGUIComponent> rgcs

timeout

public int timeout

sessionId

public java.lang.String sessionId

tempFolderName

public java.lang.String tempFolderName

DefaultCursor

protected java.awt.Cursor DefaultCursor

WaitCursor

protected java.awt.Cursor WaitCursor

winBounds

protected java.util.Hashtable<java.lang.String,de.must.applet.RGUIGlobal.WinProp> winBounds

loggedOut

protected boolean loggedOut

parametersFromPropertyFiles

protected ParametersFromPropertyFiles parametersFromPropertyFiles

Constructor Detail

RGUIGlobal

public RGUIGlobal()

Method Detail

getInstance

public static final RGUIGlobal getInstance()

setRGUI

public void setRGUI(RGUI rgui)

getRGUI

public RGUI getRGUI()

getMainWindow

public javax.swing.JFrame getMainWindow()

Description copied from interface: FrontendResources

Returns the main window of the application.

Specified by:

getMainWindow in interface FrontendResources

Returns:

the main window of the application

setAppletContext

public void setAppletContext(java.applet.AppletContext appletContext)

getAppletContext

public java.applet.AppletContext getAppletContext()

setServletName

public void setServletName(java.lang.String servletName)

getServletName

public java.lang.String getServletName()

setCodeBase

public void setCodeBase(java.lang.String codeBase)

getCodeBase

public java.lang.String getCodeBase()

setProxy

public void setProxy(java.lang.String proxyHost,
                     int proxyPort,
                     java.lang.String proxyUserName,
                     java.lang.String proxyPassword)

Sets proxy information - not for applet, but for application.

Parameters:

proxyHost -

proxyPort -

proxyUserName -

proxyPassword -

setLanguage

public void setLanguage(int language)

startLogoutControl

public void startLogoutControl(MustLabel infoLabel)

Starts logout control.

Parameters:

infoLabel - the (new) label to receive information about remaining login time (may change due to look and feel changes)

setStatusLoggedOutToStopLogoutControl

public void setStatusLoggedOutToStopLogoutControl()

createButton

public MustButton createButton(java.lang.String imageName,
                               java.lang.String defaultLabel)

createButton

public MustButton createButton(java.lang.String imageName,
                               java.lang.String defaultLabel,
                               java.lang.String tooltiptext,
                               java.lang.String actionCommand,
                               java.awt.event.ActionListener l)

getImageIcon

public javax.swing.ImageIcon getImageIcon(java.lang.String imageName)

Description copied from interface: ImageResource

Returns an image loaded by name from typical images folder, e.g. /bin/images.

Specified by:

getImageIcon in interface ImageResource

Parameters:

imageName - the name of image icon to load

Returns:

the loaded image

getImageIconIndividual

public javax.swing.ImageIcon getImageIconIndividual(java.lang.String imagePath)

Description copied from interface: ImageResource

Returns image icons for path as specified - in opposite to getImageIcon, the image is searched absolutely respectively below current directory or the code base in case of applets.

Specified by:

getImageIconIndividual in interface ImageResource

Parameters:

imagePath - the path of the image file to be loaded

Returns:

the image icon

playSound

public void playSound(java.lang.String soundFileName)

Overrides:

playSound in class SuperGlobal

getFrameworkResourceString

public java.lang.String getFrameworkResourceString(java.lang.String resourceKey)

Returns a package specific resource as a string.

Specified by:

getFrameworkResourceString in interface FrameworkTextResource

Parameters:

resourceKey - the key of the resource to retrieve

Returns:

the resource

register

public void register(java.lang.String id,
                     RemoteGUIComponent remoteGUIComponent)

getRemoteGUIComponent

public RemoteGUIComponent getRemoteGUIComponent(java.lang.String id)

getIdString

public java.lang.String getIdString(java.util.Vector<Identifier> identifiers)

getIdString

public java.lang.String getIdString(Identifier[] identifiers)

contactServer

public de.must.applet.RGUIGlobal.Veto contactServer(KeyValuePairAlpha param)
                                             throws java.io.IOException

Contacts assigned server with parameters as specified.

Parameters:

param - the parameter to send to the server

Returns:

veto data if request is rejected or null if request isn't rejected

Throws:

java.io.IOException

contactServer

public de.must.applet.RGUIGlobal.Veto contactServer(KeyValuePairAlpha param,
                                                    boolean ownThread)
                                             throws java.io.IOException

Contacts assigned server with parameters as specified.

Parameters:

params - the parameters to send to the server

ownThread - whether or not server should be contacted in an own thread

Returns:

veto data if request is rejected or null if request isn't rejected

Throws:

java.io.IOException

contactServer

public de.must.applet.RGUIGlobal.Veto contactServer(java.util.Vector<KeyValuePairAlpha> params)
                                             throws java.io.IOException

Contacts assigned server with parameters as specified.

Parameters:

params - the parameters to send to the server

Returns:

veto data if request is rejected or null if request isn't rejected

Throws:

java.io.IOException

contactServer

public de.must.applet.RGUIGlobal.Veto contactServer(java.util.Vector<KeyValuePairAlpha> params,
                                                    boolean ownThread,
                                                    boolean callEvenIfThreadIsPending)
                                             throws java.io.IOException

Contacts assigned server with parameters as specified.

Parameters:

params - the parameters to send to the server

ownThread - whether or not server should be contacted in an own thread

callEvenIfThreadIsPending - whether or not server is to be called even if a contact in an own thread is still pending

Returns:

veto data if request is rejected or null if request isn't rejected

Throws:

java.io.IOException

contactServerInOwnThread

public void contactServerInOwnThread(java.util.Vector<KeyValuePairAlpha> params)
                              throws java.io.IOException

Contacts assigned server with parameters as specified using a new thread.

Parameters:

params - the parameters to send to the server

Throws:

java.io.IOException

getServerInputStream

protected java.io.BufferedReader getServerInputStream(java.util.Vector<KeyValuePairAlpha> params)
                                               throws java.net.MalformedURLException,
                                                      java.io.IOException,
                                                      java.net.ProtocolException,
                                                      java.io.UnsupportedEncodingException

Returns an input stream to receive server data for the parameters as specified.

Parameters:

params - the parameters to send to the server

Returns:

an input stream to receive server data for the parameters as specified

Throws:

java.net.MalformedURLException

java.io.IOException

java.net.ProtocolException

java.io.UnsupportedEncodingException

upload

public boolean upload(java.lang.String fileName,
                      java.util.Vector<KeyValuePairAlpha> params,
                      java.io.FileInputStream inputStream)

getInputStream

public java.io.InputStream getInputStream(java.util.Vector<KeyValuePairAlpha> params)
                                   throws java.io.IOException

Throws:

java.io.IOException

remove

public void remove(AppletGUIs gui)

removeTask

public void removeTask(java.lang.String title)

logout

public void logout()

Perform logout. Command is sent to server to remove session from cache. Special case: If application doesn't need login, this function removes session from cache anyway.

download

public boolean download(java.lang.String inputPath,
                        java.lang.String outputPath)
                 throws java.io.IOException

Throws:

java.io.IOException

download

public boolean download(java.lang.String inputPath,
                        java.lang.String outputPath,
                        boolean override)
                 throws java.io.IOException

Throws:

java.io.IOException

isURLavailable

public boolean isURLavailable(java.lang.String url)

downloadFromURL

public boolean downloadFromURL(java.lang.String url,
                               java.lang.String outputPath,
                               boolean override)
                        throws java.io.IOException

Throws:

java.io.IOException

getServerFileReader

public java.io.BufferedReader getServerFileReader(java.lang.String relativeFilePath)
                                           throws java.io.IOException

Returns a buffered file reader to access a server file.

Parameters:

relativeFilePath - the relative path form the current webapp to the file to access

Returns:

the buffered file reader to access a file

Throws:

java.io.IOException

isServerCallThreadPending

public boolean isServerCallThreadPending()

Returns true if a server contact in an own thread is pending.

Returns:

true if a server contact in an own thread is pending