TestConnector (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.TestConnector

All Implemented Interfaces:: ClientSessionListener, ConnectorLoadInterface, ServerProcessListener, VirtualComponentListener, VirtualPanelCreationListener, VirtualPanelEventListener, VirtualPanelListener

public class TestConnector
extends Object
implements ConnectorLoadInterface, ServerProcessListener, VirtualPanelEventListener, VirtualPanelCreationListener, ClientSessionListener, VirtualComponentListener

A test connector.

Field Summary
- Fields inherited from interface se.entra.phantom.server.VirtualPanelListener
  ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_QUESTION, ICON_WARNING, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES

Constructor Summary

Constructors
Constructor and Description

TestConnector()

Constructors
Constructor and Description
`TestConnector()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getConnectorDescription()` Gets the description of this connector (perhaps not the same one as specified in the "onConnectorLoad" call).
`long`	`getRemainingStartTime(ClientSessionManager csm, int restartType)` Gets the time in milliseconds before a start of the server is possible.
`long`	`getRemainingStopTime(ClientSessionManager csm, int restartType)` Gets the time in milliseconds before a stop of the server is possible.
`void`	`onAction(VirtualPanel panel, VirtualControl control, String controlID)` Push buttons generates this event when selected.
`void`	`onAction(VirtualPanel panel, VirtualMenuItem menuItem, String controlID)` Menu items (or pop-up menu items) generates this event when selected.
`void`	`onCheckedChange(VirtualPanel panel, VirtualControl control, String controlID, int state)` Check boxes and radio buttons generates this event when state is changed on the client side.
`void`	`onClientInitialize(ClientSession cs, VirtualSessionManager vsm)` Called when the client is initialized, but before any panel session, application panel, etc has been created.
`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`	`onConnect(ClientSession cs)` Called when the client session has been established.
`void`	`onConnectorLoad(ClientSessionManager csm, String description)` Called when the Connector has been loaded.
`void`	`onConnectorUnload(ClientSessionManager csm)` Called when the Connector has been unloaded.
`void`	`onContentChanged(VirtualPanel panel, VirtualControl control, String controlID, String text)` Entry fields and multiple line entry fields generates this message.
`void`	`onContentChanged(VirtualPanel panel, VirtualControl control, String controlID, String text, int line)` Combination boxes and spin buttons generates this message.
`void`	`onControlEvent(VirtualPanel panel, VirtualControl control, int event)` The general notification event for "normal" controls.
`void`	`onDispose(ClientSession cs)` Called when the client session is going to be disposed.
`void`	`onDisposed(ClientSession cs)` Called when the client session has been disposed of, typically to let the connector perform some kind of clean up.
`void`	`onError(ClientSession cs, Throwable t)` Called when the client session has caused an error and will eventually be disposed of.
`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`	`onFocusGained(VirtualPanel panel, VirtualControl control, String controlID)` Controls that can receive input focus generates this event when they gain focus.
`void`	`onFocusLost(VirtualPanel panel, VirtualControl control, String controlID)` Controls that can receive input focus generates this event when they lose focus.
`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`	`onMenuAction(VirtualPanel panel, VirtualMenuItem menuItem)` Menu items generates this event when selected.
`void`	`onPageActivated(VirtualPanel panel)` Called when a notebook page becomes active due to user interaction.
`boolean`	`onPanelClose(VirtualPanel panel)` Called when the close button of a panel is pressed.
`boolean`	`onPanelClosing(VirtualPanel panel)` Called when the close button of a panel is pressed, but before any other processing has been done.
`void`	`onPanelCreate(VirtualPanel panel)` Called when a panel is created.
`void`	`onPanelCreation(VirtualPanel panel)` Called when a panel is created.
`void`	`onPanelDestroy(VirtualPanel panel)` Called when a panel is about to be destroyed.
`void`	`onPanelDestruction(VirtualPanel panel)` Called when a panel is about to be destroyed.
`void`	`onPropertyChange(VirtualPanel panel, VirtualControl control, String controlID, String propertyName, Object property)` A control notifies the listener using this event when custom properties needs to be handled.
`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.
`void`	`onSelectionChanged(VirtualPanel panel, VirtualCListBox list, String controlID, int line, int column)` List boxes generates this message.
`void`	`onStart(ClientSessionManager csm, int restartType)` Called just after all the Connectors are loaded and when the server is about to start.
`void`	`onStarted(ClientSessionManager csm, int restartType)` Called when the server has completed all the startup jobs and is in ready state.
`void`	`onStop(ClientSessionManager csm, int restartType)` Called when the server is about to initiate the stop process.
`void`	`onStopped(ClientSessionManager csm, int restartType)` Called when the server has reached the full stop state and will unload all connectors.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TestConnector
```
public TestConnector()
```
- Method Detail
  - onConnectorLoad
```
public void onConnectorLoad(ClientSessionManager csm,
                            String description)
```
    Called when the Connector has been loaded.
    
    Specified by:
    
    onConnectorLoad in interface ConnectorLoadInterface
    
    Parameters:
    
    csm - The instance of the ClientSessionManager.
  - onConnectorUnload
```
public void onConnectorUnload(ClientSessionManager csm)
```
    Called when the Connector has been unloaded.
    
    Specified by:
    
    onConnectorUnload in interface ConnectorLoadInterface
    
    Parameters:
    
    csm - The instance of the ClientSessionManager.
  - getConnectorDescription
```
public String getConnectorDescription()
```
    Gets the description of this connector (perhaps not the same one as specified in the "onConnectorLoad" call).
    
    Specified by:
    
    getConnectorDescription in interface ConnectorLoadInterface
  - onStart
```
public void onStart(ClientSessionManager csm,
                    int restartType)
```
    Called just after all the Connectors are loaded and when the server is about to start.
    
    Specified by:
    
    onStart in interface ServerProcessListener
    
    Parameters:
    
    csm - The ClientSessionManager instance.
    
    restartType - Value indicating the restart type of the server process,
  - getRemainingStartTime
```
public long getRemainingStartTime(ClientSessionManager csm,
                                  int restartType)
```
    Gets the time in milliseconds before a start of the server is possible. This method may be called several times during the server start process in order to check that all connectors started properly. The return value should be zero if the connector is started successfully.
    
    Specified by:
    
    getRemainingStartTime in interface ServerProcessListener
    
    Parameters:
    
    csm - The ClientSessionManager instance.
    
    restartType - Value indicating the restart type of the server process,
    
    Returns:
    
    milliseconds The amount of milliseconds that the start server thread must wait in order for all connectors to complete their "start process".
  - onStarted
```
public void onStarted(ClientSessionManager csm,
                      int restartType)
```
    Called when the server has completed all the startup jobs and is in ready state.
    
    Specified by:
    
    onStarted in interface ServerProcessListener
    
    Parameters:
    
    csm - The ClientSessionManager instance.
    
    restartType - Value indicating the restart type of the server process,
  - onStop
```
public void onStop(ClientSessionManager csm,
                   int restartType)
```
    Called when the server is about to initiate the stop process. The restart parameter indicates if the server will be restarted and if so how.
    
    Specified by:
    
    onStop in interface ServerProcessListener
    
    Parameters:
    
    csm - The ClientSessionManager instance.
    
    restartType - Value indicating the restart type of the server process.
  - getRemainingStopTime
```
public long getRemainingStopTime(ClientSessionManager csm,
                                 int restartType)
```
    Gets the time in milliseconds before a stop of the server is possible. The maximum time the server will wait is defined in "server.ini". This method may be called several times during the server stop process in order to check that all connectors stops properly. If the maximum wait time is exceeded, the server will stop in all cases. The return value should be zero if the connector is stopped successfully.
    
    Specified by:
    
    getRemainingStopTime in interface ServerProcessListener
    
    Parameters:
    
    csm - The ClientSessionManager instance.
    
    restartType - Value indicating the restart type of the server process,
    
    Returns:
    
    milliseconds The amount of milliseconds that the stop server thread must wait in order for all connectors to complete their "stop process".
  - onStopped
```
public void onStopped(ClientSessionManager csm,
                      int restartType)
```
    Called when the server has reached the full stop state and will unload all connectors.
    
    Specified by:
    
    onStopped in interface ServerProcessListener
    
    Parameters:
    
    csm - The ClientSessionManager instance.
    
    restartType - Value indicating the restart type of the server process.
  - onConnect
```
public void onConnect(ClientSession cs)
```
    Called when the client session has been established.
    
    Specified by:
    
    onConnect in interface ClientSessionListener
    
    Parameters:
    
    cs - The client session.
  - onClientInitialize
```
public void onClientInitialize(ClientSession cs,
                               VirtualSessionManager vsm)
```
    Called when the client is initialized, but before any panel session, application panel, etc has been created.
    
    Specified by:
    
    onClientInitialize in interface ClientSessionListener
    
    Parameters:
    
    cs - The client session.
    
    vsm - The VirtualSessionManager instance of the client session.
  - onError
```
public void onError(ClientSession cs,
                    Throwable t)
```
    Called when the client session has caused an error and will eventually be disposed of.
    
    Specified by:
    
    onError in interface ClientSessionListener
    
    Parameters:
    
    cs - The client session.
    
    t - The Throwable that caused the client session error.
  - onDispose
```
public void onDispose(ClientSession cs)
```
    Called when the client session is going to be disposed.
    
    Specified by:
    
    onDispose in interface ClientSessionListener
    
    Parameters:
    
    cs - The client session.
  - onDisposed
```
public void onDisposed(ClientSession cs)
```
    Called when the client session has been disposed of, typically to let the connector perform some kind of clean up.
    
    Specified by:
    
    onDisposed in interface ClientSessionListener
    
    Parameters:
    
    cs - The client session.
  - onPanelCreation
```
public void onPanelCreation(VirtualPanel panel)
```
    Called when a panel is created.
    
    Specified by:
    
    onPanelCreation in interface VirtualPanelCreationListener
  - onPanelDestruction
```
public void onPanelDestruction(VirtualPanel panel)
```
    Called when a panel is about to be destroyed.
    
    Specified by:
    
    onPanelDestruction in interface VirtualPanelCreationListener
  - onPanelCreate
```
public void onPanelCreate(VirtualPanel panel)
```
    Called when a panel is created.
    
    Specified by:
    
    onPanelCreate in interface VirtualPanelListener
  - onPanelDestroy
```
public void onPanelDestroy(VirtualPanel panel)
```
    Called when a panel is about to be destroyed.
    
    Specified by:
    
    onPanelDestroy in interface VirtualPanelListener
  - onRefreshBegin
```
public 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.
    
    Specified by:
    
    onRefreshBegin in interface VirtualPanelEventListener
    
    Parameters:
    
    panel - The virtual panel instance.
    
    component - The virtual control, null when the panel is processed.
  - onRefreshEnd
```
public 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.
    
    Specified by:
    
    onRefreshEnd in interface VirtualPanelEventListener
    
    Parameters:
    
    panel - The virtual panel instance.
    
    component - The virtual control, null when the panel is processed.
  - onClientUpdatedBegin
```
public 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.
    
    Specified by:
    
    onClientUpdatedBegin in interface VirtualPanelEventListener
    
    Parameters:
    
    panel - The virtual panel instance.
    
    component - The virtual control, null when the panel is processed.
  - onClientUpdatedEnd
```
public 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.
    
    Specified by:
    
    onClientUpdatedEnd in interface VirtualPanelEventListener
    
    Parameters:
    
    panel - The virtual panel instance.
    
    component - The virtual control, null when the panel is processed.
  - onFocus
```
public 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.
    
    Specified by:
    
    onFocus in interface VirtualPanelEventListener
    
    Parameters:
    
    panel - The virtual panel for new "viNew" component.
    
    component - The component that receives the focus.
  - onFireCreate
```
public void onFireCreate(VirtualPanel panel)
```
    Called prior to firing the panel creation transaction to the client.
    
    Specified by:
    
    onFireCreate in interface VirtualPanelEventListener
    
    Parameters:
    
    panel - The virtual panel instance.
  - onFireUpdate
```
public void onFireUpdate(VirtualPanel panel)
```
    Called prior to firing the panel update transaction to the client.
    
    Specified by:
    
    onFireUpdate in interface VirtualPanelEventListener
    
    Parameters:
    
    panel - The virtual panel instance.
  - onIssueActionBegin
```
public void onIssueActionBegin(VirtualPanel panel,
                               int actionType,
                               int action,
                               VirtualInterface item)
```
    Called when an action is to be performed. Valid actions are found in "common.NetPhantomConstants":
```
   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.
    Specified by:
    
    onIssueActionBegin in interface VirtualPanelEventListener
    
    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
```
public void onIssueActionEnd(VirtualPanel panel,
                             int actionType,
                             int action,
                             VirtualInterface item)
```
    Called when an action has been performed. Valid actions are found in "common.NetPhantomConstants":
```
   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.
    Specified by:
    
    onIssueActionEnd in interface VirtualPanelEventListener
    
    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.
  - onPanelClosing
```
public boolean onPanelClosing(VirtualPanel panel)
```
    Called when the close button of a panel is pressed, but before any other processing has been done. If this function returns false, the application close object will be called (if defined), otherwise a faked keypress of the Escape key is performed. If these two actions failed (because there is no close object or no button or menu item is connected to the Escape key), then the function onPanelClose is called.
    
    Specified by:
    
    onPanelClosing in interface VirtualPanelListener
    
    Returns:
    
    false to proceed with default processing,
    true to cancel closing of the panel.
    
    See Also:
    
    onPanelClose(se.entra.phantom.server.VirtualPanel)
  - onPanelClose
```
public boolean onPanelClose(VirtualPanel panel)
```
    Called when the close button of a panel is pressed. When a panel has a listener attached to it, it will not perform default close operations. The listener should dismiss or destroy the panel unless cancelling of the panel is not permitted.
    
    Specified by:
    
    onPanelClose in interface VirtualPanelListener
    
    Returns:
    
    false to proceed with default processing,
    true to stop processing panel close.
    
    See Also:
    
    onPanelClosing(se.entra.phantom.server.VirtualPanel)
  - onPageActivated
```
public void onPageActivated(VirtualPanel panel)
```
    Called when a notebook page becomes active due to user interaction. This call is directed to the notebook page listener.
    
    Specified by:
    
    onPageActivated in interface VirtualPanelListener
  - onFocusGained
```
public void onFocusGained(VirtualPanel panel,
                          VirtualControl control,
                          String controlID)
```
    Controls that can receive input focus generates this event when they gain focus.
    
    Specified by:
    
    onFocusGained in interface VirtualComponentListener
  - onFocusLost
```
public void onFocusLost(VirtualPanel panel,
                        VirtualControl control,
                        String controlID)
```
    Controls that can receive input focus generates this event when they lose focus.
    
    Specified by:
    
    onFocusLost in interface VirtualComponentListener
  - onContentChanged
```
public void onContentChanged(VirtualPanel panel,
                             VirtualControl control,
                             String controlID,
                             String text)
```
    Entry fields and multiple line entry fields generates this message.
    
    Specified by:
    
    onContentChanged in interface VirtualComponentListener
  - onContentChanged
```
public void onContentChanged(VirtualPanel panel,
                             VirtualControl control,
                             String controlID,
                             String text,
                             int line)
```
    Combination boxes and spin buttons generates this message. The line parameter is set to -1 if no line is selected.
    
    Specified by:
    
    onContentChanged in interface VirtualComponentListener
  - onSelectionChanged
```
public void onSelectionChanged(VirtualPanel panel,
                               VirtualCListBox list,
                               String controlID,
                               int line,
                               int column)
```
    List boxes generates this message. The line and column parameter are individually set to -1 if no line or column is selected respectively.
    
    Specified by:
    
    onSelectionChanged in interface VirtualComponentListener
  - onAction
```
public void onAction(VirtualPanel panel,
                     VirtualControl control,
                     String controlID)
```
    Push buttons generates this event when selected.
    
    Specified by:
    
    onAction in interface VirtualComponentListener
  - onAction
```
public void onAction(VirtualPanel panel,
                     VirtualMenuItem menuItem,
                     String controlID)
```
    Menu items (or pop-up menu items) generates this event when selected.
    
    Specified by:
    
    onAction in interface VirtualComponentListener
  - onControlEvent
```
public void onControlEvent(VirtualPanel panel,
                           VirtualControl control,
                           int event)
```
    The general notification event for "normal" controls.
    The event parameter is one of the events as defined with the CE_* variables.
    The event parameter can also be a user defined value that starts with CE_USER_DEFINED. In this case, the control parameter is a VirtualCUserWindow instance.
    
    Specified by:
    
    onControlEvent in interface VirtualComponentListener
  - onMenuAction
```
public void onMenuAction(VirtualPanel panel,
                         VirtualMenuItem menuItem)
```
    Menu items generates this event when selected.
    
    Specified by:
    
    onMenuAction in interface VirtualComponentListener
  - onCheckedChange
```
public void onCheckedChange(VirtualPanel panel,
                            VirtualControl control,
                            String controlID,
                            int state)
```
    Check boxes and radio buttons generates this event when state is changed on the client side.
    The state is 0=unchecked, 1=checked and 2=third state (only for check boxes, or PhantomCCheckBox.STATE_UNDETERMINED).
    
    Specified by:
    
    onCheckedChange in interface VirtualComponentListener
  - onPropertyChange
```
public void onPropertyChange(VirtualPanel panel,
                             VirtualControl control,
                             String controlID,
                             String propertyName,
                             Object property)
```
    A control notifies the listener using this event when custom properties needs to be handled.
    The object is in general dependant of the property change event string.
    
    Specified by:
    
    onPropertyChange in interface VirtualComponentListener

Class TestConnector

Field Summary

Fields inherited from interface se.entra.phantom.server.VirtualPanelListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TestConnector

Method Detail

onConnectorLoad

onConnectorUnload

getConnectorDescription

onStart

getRemainingStartTime

onStarted

onStop

getRemainingStopTime

onStopped

onConnect

onClientInitialize

onError

onDispose

onDisposed

onPanelCreation

onPanelDestruction

onPanelCreate

onPanelDestroy

onRefreshBegin

onRefreshEnd

onClientUpdatedBegin

onClientUpdatedEnd

onFocus

onFireCreate

onFireUpdate

onIssueActionBegin

onIssueActionEnd

onPanelClosing

onPanelClose

onPageActivated

onFocusGained

onFocusLost

onContentChanged

onContentChanged

onSelectionChanged

onAction

onAction

onControlEvent

onMenuAction

onCheckedChange

onPropertyChange