se.entra.phantom.server

Class VirtualComponentAdapter

java.lang.Object

se.entra.phantom.server.VirtualPanelAdapter

se.entra.phantom.server.VirtualComponentAdapter

All Implemented Interfaces:

VirtualComponentListener, VirtualPanelListener

Direct Known Subclasses:

AdminCatchAsEE, AdminClientTerminal, AdminConfigClientFontMetrics, AdminConfigClusterController, AdminConfigEventLogPopUp, AdminConfigEventMessengers, AdminConfigFileManager, AdminConfigHostPrint3270, AdminConfigLookAndFeel, AdminConfigPorts, AdminConfigResource, AdminConfigSelectDirectory, AdminConfigSelectFile, AdminConfigSessionPooling, AdminConfigSSL, AdminConfigUpgrade, AdminConfigUser, AdminConfigWebServer, AdminToolbox, AdminUtilClientToServerFileTransfer, AdminUtilServerToClientFileTransfer, AdvancedDiagnostics, CertificateWizardListener, DisplayResolution, HostScreenAnalyze, JavaComponentObject_Extends, JavaConfig, LicenseAgreement, ListAndColor, MigrateApp, NewProject, PerformanceData, PublishApplication, RemoteAssistance, SecureLogin, TerminalAbout, TerminalApplication, TerminalApplicationProperties, TerminalChangeSession, TerminalCutCopyParsing, UpgradeEditorAndServer, ViewReferences

public abstract class VirtualComponentAdapter
extends VirtualPanelAdapter
implements VirtualComponentListener

When a panel is created for non-Server automated processing, this convenience adapter is used to listen to control events.

This adapter extends VirtualPanelAdapter and has a generic event message structure.

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
VirtualComponentAdapter()

Method Summary

Modifier and Type	Method and Description
void	onAction(VirtualPanel panel, String controlID) Push buttons and menu items (or pop-up menu items) generates this event when selected and the original onAction wasn't processed.
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	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	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	onMenuAction(VirtualPanel panel, VirtualMenuItem menuItem) Deprecated. Replaced with onAction(VirtualPanel panel,VirtualMenuItem menuItem,String controlID).
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	onSelectionChanged(VirtualPanel panel, VirtualCListBox list, String controlID, int line, int column) List boxes generates this message.

Methods inherited from class se.entra.phantom.server.VirtualPanelAdapter

onModalPanelCreate, onModalPanelProcessing, onPageActivated, onPanelClose, onPanelClosing, onPanelCreate, onPanelDestroy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

onPageActivated, onPanelClose, onPanelClosing, onPanelCreate, onPanelDestroy

Constructor Detail

VirtualComponentAdapter

public VirtualComponentAdapter()

Method Detail

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

Parameters:

panel - The panel issuing the event, parent of the control.

control - The control issuing the event.

controlID - The control ID issuing the event.

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

Parameters:

panel - The panel issuing the event, parent of the control.

control - The control issuing the event.

controlID - The control ID issuing the event.

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

Parameters:

panel - The panel issuing the event, parent of the control.

control - The control issuing the event.

controlID - The control ID issuing the event.

text - The control text contents.

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.

The default implementation in this adapter calls onContentChanged(panel,control,controlID,text).

Specified by:

onContentChanged in interface VirtualComponentListener

Parameters:

panel - The panel issuing the event, parent of the control.

control - The control issuing the event.

controlID - The control ID issuing the event.

text - The control text contents.

line - The selected line, or -1 for none.

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

Parameters:

panel - The panel issuing the event, parent of the control.

list - The list box control issuing the event.

controlID - The control ID issuing the event.

line - The selected line, or -1 for none.

column - The selected column, or -1 for none.

onAction

public void onAction(VirtualPanel panel,
                     VirtualControl control,
                     String controlID)

Push buttons generates this event when selected.

The default implementation in this adapter calls onAction(panel,controlID).

Specified by:

onAction in interface VirtualComponentListener

Parameters:

panel - The panel issuing the event, parent of the control.

control - The control issuing the event.

controlID - The control ID issuing the event.

onAction

public void onAction(VirtualPanel panel,
                     VirtualMenuItem menuItem,
                     String controlID)

Menu items (or pop-up menu items) generates this event when selected.

The default implementation in this adapter calls onAction(panel,controlID).

Specified by:

onAction in interface VirtualComponentListener

Parameters:

panel - The panel issuing the event, parent of the control.

menuItem - The menu item issuing the event.

controlID - The control ID issuing the event.

onAction

public void onAction(VirtualPanel panel,
                     String controlID)

Push buttons and menu items (or pop-up menu items) generates this event when selected and the original onAction wasn't processed.

Parameters:

panel - The panel issuing the event, parent of the control.

controlID - The control ID issuing the event.

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.

This method is currently unused and reserved for future use.

Specified by:

onControlEvent in interface VirtualComponentListener

Parameters:

panel - The panel issuing the event, parent of the control.

control - The control issuing the event.

event - Event value.

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

Parameters:

panel - The panel issuing the event, parent of the control.

control - The control issuing the event.

controlID - The control ID issuing the event.

state - State (0=unchecked, 1=checked and 2=third state [only for check boxes]).

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 dependent of the property change event string.

Specified by:

onPropertyChange in interface VirtualComponentListener

Parameters:

panel - The panel issuing the event, parent of the control.

control - The control issuing the event.

controlID - The control ID issuing the event.

propertyName - The property name.

property - Property value depending on the property name.

onMenuAction

@Deprecated
public void onMenuAction(VirtualPanel panel,
                                      VirtualMenuItem menuItem)

Deprecated. Replaced with onAction(VirtualPanel panel,VirtualMenuItem menuItem,String controlID).

Menu items generates this event when selected.

Specified by:

onMenuAction in interface VirtualComponentListener