com.portal.bas

Class PAppletServices

java.lang.Object

com.portal.bas.PClientServices

com.portal.bas.PAppletServices

public class PAppletServices
extends PClientServices

PAppletServices is a utility class that can be used for all Portal-aware applets. It provides basic login and Portal connection features.

Version:

6

Author:

Larry Lynch-Freshner

Field Summary

Fields inherited from class com.portal.bas.PClientServices

mBAServer, mConnection, mCSHManager, mDefaults, mHelp, mHelpSet, mPool, mResources, RESKEY

Method Summary

Modifier and Type	Method and Description
Applet	getApplet() Gets the applet instance.
Properties	getDefaultProperties() Gets the default properties.
Component	getMainPane() Called to gain access to the main component (the applet panel) underlying the applet, or a frame if the HTML document has a defined PARAM window = frame.
String[][]	getParameterInfo() Overrides the Applet getParameterInfo() method.
PBAServer	getServer() Gets a reference to the BAS server class.
PBAServer	getServer(URL doc) Gets a reference to the BAS server class, given a URL for the source document.
ImageIcon	loadImageIcon(String name) Gets an icon to represent the BAS server.

Methods inherited from class com.portal.bas.PClientServices

addResourceBundle, confirmationMsg, confirmationMsg, confirmationMsg, confirmationMsg, connect, createClass, createClientException, createController, createDialogClass, createModelHandle, createNewModel, doLogin, doLogin, doLogout, errorMsg, errorMsg, errorMsg, errorMsg, getClassToInstantiate, getContext, getCSHManager, getDefaultBook, getHelpObj, getModelField, getPermissionFor, getResource, getResources, getRestrictionOn, getUserPreferences, init, initHelp, invokeInThread, invokeInThread, isConnectedToInfranet, lastChanceLogin, loadImageIcon, logRemote, mergeHelp, registerApp, registerComponent, registerHelpButton, registerHelpIDFor, releaseContext, saveUserPreferences, setModelField, setPropertyURL, setPropertyURL, setUserPreferences, unregisterComponent

Methods inherited from class java.lang.Object

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

Method Detail

getMainPane

public Component getMainPane()

Called to gain access to the main component (the applet panel) underlying the applet, or a frame if the HTML document has a defined PARAM window = frame.

Specified by:

getMainPane in class PClientServices

Returns:

The lowest accessable Component.

See Also:

PAppletServices, PBuilderServices, PApplicationServices

getDefaultProperties

public Properties getDefaultProperties()

Gets the default properties. These can include properties specified in the applet's "param" spec.

Specified by:

getDefaultProperties in class PClientServices

Returns:

A Properties object.

getParameterInfo

public String[][] getParameterInfo()

Overrides the Applet getParameterInfo() method. Returns a String matrix that describes the parameters required by Portal applets.

Returns:

A String matrix.

getApplet

public Applet getApplet()

Gets the applet instance.

Returns:

The applet instance.

loadImageIcon

public ImageIcon loadImageIcon(String name)

Gets an icon to represent the BAS server.

Overrides:

loadImageIcon in class PClientServices

Parameters:

name - the name of the image to use for the icon

Returns:

An icon that represents the BAS server.

getServer

public PBAServer getServer()

Gets a reference to the BAS server class.

Specified by:

getServer in class PClientServices

Returns:

A reference to the BAS server.

getServer

public PBAServer getServer(URL doc)

Gets a reference to the BAS server class, given a URL for the source document.

Parameters:

doc - the URL of the source document

Returns:

A reference to the BAS server.