com.wirefusion.player
Interface Display

public interface Display

All WireFusion players must use this interface.

Method Summary

java.awt.Container	getAwtContainer() Returns a java.awt.Container object (or subclass of Container).
java.lang.String	getParameter(java.lang.String name) Returns the value of the named external parameter in the presentation.
java.awt.PopupMenu	getPopupMenu() Returns the PopupMenu object of the player.
void	send(java.lang.String linkName, java.lang.String argument) By calling this method, a player event of type EXTERNAL_MESSAGE_EVENT will be generated and sent to all player event listeners.
void	showDocument(java.net.URL url, java.lang.String target) Requests that the presentation player shows the Web page indicated by the url argument.
void	showStatus(java.lang.String text) Requests that the argument string be displayed in the "status window".

Method Detail

getAwtContainer

java.awt.Container getAwtContainer()

Returns a java.awt.Container object (or subclass of Container). For most players, this is the AWT component showing the presentation.

Returns:

a Container object

showDocument

void showDocument(java.net.URL url,
                  java.lang.String target)

Requests that the presentation player 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.

A presentation player is free to ignore showDocument.

Parameters:

url - an absolute URL giving the location of the document.

target - a String indicating where to display the page.

getParameter

java.lang.String getParameter(java.lang.String name)

Returns the value of the named external parameter in the presentation.

Parameters:

name - a parameter name.

Returns:

the value of the named parameter, or null if not set.

showStatus

void showStatus(java.lang.String text)

Requests that the argument string be displayed in the "status window". Note: Some players may not have a status window.

Parameters:

text - a string to display in the status window.

getPopupMenu

java.awt.PopupMenu getPopupMenu()

Returns the PopupMenu object of the player. If no popup menu exists, null will be returned.

Returns:

a popup menu, or null if no popupmenu exists.

send

void send(java.lang.String linkName,
          java.lang.String argument)

By calling this method, a player event of type EXTERNAL_MESSAGE_EVENT will be generated and sent to all player event listeners. Intended for calls from "external" sources, like JavaScript (AppletPlayer) or other Java applications (ComponentPlayer).

Parameters:

linkName - a name normally used for identifying the destination of the PlayerEvent

argument - any string argument