PATH Documentation > WebObjects

Table of Contents

WOJavaClientApplet


Inherits from:
com.webobjects.appserver.WOComponent
Package:
com.webobjects.eodistribution

Class Description

WOJavaClientApplet is the web component used by Java Client applications to create and download to the client an applet of class com.apple.client.interface.EOApplet. This component passes several parameters to the applet, including the dimensions, code/codebase, and additional EOApplication-specific parameters-such as the initial EOInterfaceController subclass name and language.

WOJavaClientApplet is able to generate the HTML required by SunSoft's Java Plug-in for Microsoft's Internet Explorer and Netscape's browsers. The plug-in is usually required for Netscape, while Internet Explorer often works without it (whether or not the plug-in is required depends on the applet's contents).

Java Client applications can be started outside of a web browser using the following command-line syntax:

java -classpath path_list com.apple.client.eointerface.EOApplication application_url

When a Java Client application is started outside of a browser, the WOJavaClientApplet is still used on the server side to determine the additional EOApplication-specific parameters. Thus the bindings listed below can still apply even in the absence of a web browser.

The following tables lists those bindings used by WOJavaClientApplet:


Binding Description
width Width of applet in the HTML page.
height Height of applet in the HTML page.
useJavaPlugin If this flag is true, the WOJavaClientApplet generates HTML that causes Internet Explorer and Netscape's browsers to use SunSoft's Java Plug-in.
archive Standard applet parameter.
code Standard applet parameter.
codebase Standard applet parameter.
distributionContext The EODistributionContext used by the applet to handle requests from the client. If the WOJavaClientApplet does not have a binding for the distribution context, it instantiates one with the session's defaultEditingContext, sets the session as the delegate of the distribution context, and itself as the invocation target.
interfaceControllerClassName The class name of the initial EOInterfaceController subclass that becomes visible when an application is launched (in the applet if launched inside a browser).
applicationClassName The name of the EOApplication subclass implementing the application.
language The preferred language for the application.
channelClassName The class name of the distribution channel to be used by the client.
temporaryGIDBase The base from which temporary global ID's are generated.
allParameterNames An NSArray containing the applet's parameters.
sessionID The receiver's session ID.
componentURL The URL for the receiver's action.




Constants

WOJavaClientApplet defines the following String constants. Each constant corresponds to a WOJavaClientApplet binding and is a key for use in the dictionary returned by clientSideRequestApplicationParameters.


Constant Corresponding Binding
WidthKey width
HeightKey height
UseJavaPluginKey useJavaPlugin
ArchiveKey archive
CodeKey code
CodebaseKey codebase
DistributionContextKey distributionContext
InterfaceControllerClassNameKey interfaceControllerClassName
ApplicationClassNameKey applicationClassName
LanguageKey language
ChannelClassNameKey channelClassName
TemporaryGIDBaseKey temporaryGIDBase
AllParameterNamesKey allParameterNames
SessionIDKey sessionID
ComponentURLKey componentURL

WOJavaClientApplet also defines String constants for the names of the notifications it posts. For more information, see "Notifications" (page 40).



Constructors


WOJavaClientApplet

public WOJavaClientApplet(WOContext context)

Standard one-argument WOComponent constructor.


Instance Methods


allParameterNamesString

public String allParameterNamesString()

Returns a string containing all of the receiver's parameters separated by spaces.

applicationClassName

public String applicationClassName()

Returns a string containing the name of the EOApplication subclass the applet contains.

archive

public String archive()

If the applet has a binding for archive, the value of that binding is returned. Otherwise, the default archive binding-"eojavaclient.jar"-is returned.

channelClassName

public String channelClassName()

Returns the string value bound to the channelClassName binding. The channelClassName identifies the class of the object that the client uses for a distribution channel.

See Also: interfaceControllerClassName


clientSideRequestApplicationParameters

public NSDictionary clientSideRequestApplicationParameters()

Returns a dictionary with the values of all the bindings that have been set. This method is used by EOApplication on the client to warm up a Java application started outside of a browser.

See Also: interfaceControllerClassName


code

public String code()

If the applet has a binding for code, the value of that binding is returned. Otherwise, the default code binding-"com.apple.client.eointerface.EOApplet"-is returned.

codebase

public String codebase()

If the applet has a binding for codebase, the value of that binding is returned. Otherwise, this method checks to see if the request came through a web server and, if so, returns a URL relative to cgi-bin/WebObjects for the resource request handler. If the request didn't come through a web server, this method returns "/WebObjects/Java".

componentURL

public String componentURL()

Returns a string containing the receiver's action URL.

distributionContext

public EODistributionContext distributionContext()

Returns the EODistributionContext used by this component to handle client requests.

handleClientRequest

public Object handleClientRequest()

Using the component's EODistributionContext, generates a response for a client request.

See Also: responseToClientMessage (EODistributionContext class)


interfaceControllerClassName

public String interfaceControllerClassName()

Returns the value bound to interfaceControllerClassName.

See Also: channelClassName, clientSideRequestApplicationParameters


otherParameterNames

public NSArray otherParameterNames()

Returns an array containing the names of the nonstandard WOJavaClientApplet parameters.

otherParametersString

public String otherParametersString()

Returns a string containing the parameter names and values of the nonstandard WOJavaClientApplet parameters. The string is in the form 'name="value" name="value" ...

otherParameterValue

public String otherParameterValue()

Returns the value of the parameter corresponding to the otherParameterName instance variable.

sessionID

public String sessionID()

Returns a string containing the receiver's session ID.

shouldOmitApplicationClassName

public boolean shouldOmitApplicationClassName()

Description forthcoming.

shouldOmitChannelClassName

public boolean shouldOmitChannelClassName()

Description forthcoming.

shouldOmitInterfaceControllerClassName

public boolean shouldOmitInterfaceControllerClassName()

Description forthcoming.

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overridden from com.webobjects.appserver.WOComponent.

temporaryGIDBase

public String temporaryGIDBase()

Returns a string containing the base from which temporary global ID's are generated.


Notifications

DidVendComponentURLNotification

Posted after the WOJavaClientApplet vends a component URL. The notification contains:
Notification Object The WOJavaClientApplet that vended a component URL.
Userinfo None

WillDeallocNotification

Posted whenever the WOJavaClientApplet is about to be deallocated. The notification contains:
Notification Object The WOJavaClientApplet that's about to be deallocated.
Userinfo None


© 2001 Apple Computer, Inc. (Last Published April 17, 2001)


Table of Contents