se.entra.phantom.client

Interface TraceInterface

public interface TraceInterface

This interface is used to trace client events, typically for response time measuring and/or client activity playback.

Method Summary

Modifier and Type	Method and Description
int	onClosePanel(PPanel panel) Called when the user has requested closure of the panel, but before anything else is done (i.e.
int	onExit(String msg) Called after disposal of the client, but just before destruction or system exit.
void	onIssueAction(AEvent event) Called from menu items or push buttons, etc, when they want to issue an action event to the panel.
void	onLogEvent(String text) Called prior to logging a client event on the server.
void	onOptionDialogReply(int value) Called after the user has made the message box selection (or the automatic reply).
void	onPanelCreation(PPanel panel, String title) Called prior to creating the GUI panel.
void	onPanelDisplayed(PPanel panel) Called after the panel has been visually created, but the AWT paint thread may not yet have completed the paint.
void	onProcessKeyEvent(Component c, KeyEvent e) Called prior to processing a key event.
void	onReceiveTransaction(byte[] data) Called prior to processing a received transaction from the server.
void	onSendTransaction(byte[] data) Called prior to sending the transaction to the server.
void	onSessionLocked(boolean lock) Called when the session lock state has been changed.
void	onSessionSelected(int index) Called when a session has been placed in the foreground.
void	onSetFocusComponent(PPanel panel, Component c) Called when a component registers itself as the component in focus for a panel.
int	onShowOptionDialog(Component parentComponent, String message, String title, int optionType, int messageType, Icon icon, Object[] options, Object initialValue) Called before the modal processing of a message box.
void	onTerminalDisplayed(Component emulatorArea) Called when the terminal window has been displayed.
void	onTerminalHidden() Called when the terminal window has been hidden.

Method Detail

onReceiveTransaction

void onReceiveTransaction(byte[] data)

Called prior to processing a received transaction from the server.

onSendTransaction

void onSendTransaction(byte[] data)

Called prior to sending the transaction to the server.

onSessionLocked

void onSessionLocked(boolean lock)

Called when the session lock state has been changed.

onTerminalDisplayed

void onTerminalDisplayed(Component emulatorArea)

Called when the terminal window has been displayed.

onTerminalHidden

void onTerminalHidden()

Called when the terminal window has been hidden.

onPanelCreation

void onPanelCreation(PPanel panel,
                     String title)

Called prior to creating the GUI panel.

onPanelDisplayed

void onPanelDisplayed(PPanel panel)

Called after the panel has been visually created, but the AWT paint thread may not yet have completed the paint.

onClosePanel

int onClosePanel(PPanel panel)

Called when the user has requested closure of the panel, but before anything else is done (i.e. sending the transaction to the server).

Returns:

0 to process the request normally,
1 to stop further processing.

onSessionSelected

void onSessionSelected(int index)

Called when a session has been placed in the foreground.

onProcessKeyEvent

void onProcessKeyEvent(Component c,
                       KeyEvent e)

Called prior to processing a key event.

onIssueAction

void onIssueAction(AEvent event)

Called from menu items or push buttons, etc, when they want to issue an action event to the panel.

onLogEvent

void onLogEvent(String text)

Called prior to logging a client event on the server.

onExit

int onExit(String msg)

Called after disposal of the client, but just before destruction or system exit.

The "msg" parameter could be null if no message box was displayed before the exit.

Returns:

0 to process the request normally,
1 to stop further processing.

onShowOptionDialog

int onShowOptionDialog(Component parentComponent,
                       String message,
                       String title,
                       int optionType,
                       int messageType,
                       Icon icon,
                       Object[] options,
                       Object initialValue)

Called before the modal processing of a message box.

Return -9999 in order to keep the normal processing, i.e. to display the message box to the user and let him/her make the selection.

Otherwise return a possible pre-recorded user selection, e.g. for automatic playback.

onOptionDialogReply

void onOptionDialogReply(int value)

Called after the user has made the message box selection (or the automatic reply).

onSetFocusComponent

void onSetFocusComponent(PPanel panel,
                         Component c)

Called when a component registers itself as the component in focus for a panel.

Note that the Component may be null, in which case the panel deregisters any component in focus.