se.entra.phantom.server

Interface VirtualPanelEventListener

All Known Implementing Classes:

TestConnector

public interface VirtualPanelEventListener

This interface is used to listen to events related to panel updates by the system or from a client.

Method Summary

Modifier and Type	Method and Description
void	onClientUpdatedBegin(VirtualPanel panel, VirtualControl component) Called prior to the client update being performed.
void	onClientUpdatedEnd(VirtualPanel panel, VirtualControl component) Called after the client update has been performed.
void	onFireCreate(VirtualPanel panel) Called prior to firing the panel creation transaction to the client.
void	onFireUpdate(VirtualPanel panel) Called prior to firing the panel update transaction to the client.
void	onFocus(VirtualPanel panel, VirtualControl component) Called when the client or the system has changed focus in a panel.
void	onIssueActionBegin(VirtualPanel panel, int actionType, int action, VirtualInterface item) Called when an action is to be performed.
void	onIssueActionEnd(VirtualPanel panel, int actionType, int action, VirtualInterface item) Called when an action has been performed.
void	onRefreshBegin(VirtualPanel panel, VirtualControl component) Called before the refresh of a component is going to be done.
void	onRefreshEnd(VirtualPanel panel, VirtualControl component) Called after the refresh of a component has been done.

Method Detail

onRefreshBegin

void onRefreshBegin(VirtualPanel panel,
                    VirtualControl component)

Called before the refresh of a component is going to be done. The component is set to null when the panel is being processed.

Parameters:

panel - The virtual panel instance.

component - The virtual control, null when the panel is processed.

onRefreshEnd

void onRefreshEnd(VirtualPanel panel,
                  VirtualControl component)

Called after the refresh of a component has been done. This enables the code to override the default behavior, e.g. for a host connected component. The component is set to null when the panel is being processed.

Parameters:

panel - The virtual panel instance.

component - The virtual control, null when the panel is processed.

onClientUpdatedBegin

void onClientUpdatedBegin(VirtualPanel panel,
                          VirtualControl component)

Called prior to the client update being performed. The component is set to null when the panel is being processed.

Parameters:

panel - The virtual panel instance.

component - The virtual control, null when the panel is processed.

onClientUpdatedEnd

void onClientUpdatedEnd(VirtualPanel panel,
                        VirtualControl component)

Called after the client update has been performed. The component is set to null when the panel is being processed.

Parameters:

panel - The virtual panel instance.

component - The virtual control, null when the panel is processed.

onFocus

void onFocus(VirtualPanel panel,
             VirtualControl component)

Called when the client or the system has changed focus in a panel. When this method is called, the focus is already set to the new component, but do not assume that the client has had the time to perform the focus change operation -- it should be considered as a pending operation.

Parameters:

panel - The virtual panel that contains the component receiving focus.

component - The component that receives the focus.

onFireCreate

void onFireCreate(VirtualPanel panel)

Called prior to firing the panel creation transaction to the client.

Parameters:

panel - The virtual panel instance.

onFireUpdate

void onFireUpdate(VirtualPanel panel)

Called prior to firing the panel update transaction to the client.

Parameters:

panel - The virtual panel instance.

onIssueActionBegin

void onIssueActionBegin(VirtualPanel panel,
                        int actionType,
                        int action,
                        VirtualInterface item)

Called when an action is to be performed.

   ACTION_NONE         = 1
   ACTION_HOSTKEY      = 2
   ACTION_MENU         = 3
   ACTION_CONTROL      = 4
   ACTION_NOTEBOOKPAGE = 5
   ACTION_POPUPMENU    = 6
   ACTION_CLOSEWINDOW  = 7
 

The "item" may be null when a virtual component does not apply.

Parameters:

panel - The panel in question.

actionType - The action type ACTION_*.

action - The action value.

item - The item for the Virtual Component or null if none applies.

onIssueActionEnd

void onIssueActionEnd(VirtualPanel panel,
                      int actionType,
                      int action,
                      VirtualInterface item)

Called when an action has been performed.

   ACTION_NONE         = 1
   ACTION_HOSTKEY      = 2
   ACTION_MENU         = 3
   ACTION_CONTROL      = 4
   ACTION_NOTEBOOKPAGE = 5
   ACTION_POPUPMENU    = 6
   ACTION_CLOSEWINDOW  = 7
 

The "item" may be null when a virtual component does not apply.

Parameters:

panel - The panel in question.

actionType - The action type ACTION_*.

action - The action value.

item - The item for the Virtual Component or null if none applies.