se.entra.phantom.server

Class GofControlIdentifierAdapter

java.lang.Object

se.entra.phantom.server.GofControlIdentifierAdapter

All Implemented Interfaces:

GofControlIdentifier

Direct Known Subclasses:

GofCheckBoxIdentifier, GofComboBoxIdentifier, GofEntryFieldIdentifier, GofHorLineIdentifier, GofListBoxIdentifier, GofListContMarkIdentifier, GofOutputTextIdentifier, GofPushButtonIdentifier, GofSpinButtonIdentifier, GofTitleAreaTitleIdentifier

public abstract class GofControlIdentifierAdapter
extends Object
implements GofControlIdentifier

This is an adapter class that must be used as a base class for classes implementing the GofControlIdentifier interface.

Extending from this class, instead of directly implementing the interface, makes it possible to extend the interface with new methods in the future, without forcing a recompilation of user written GofControlIdentifier classes. Default versions of these new methods can instead be implemented in this adapter class.

Author:

J. Bergström

Field Summary

Fields

Modifier and Type	Field and Description
protected PhantomPanelData	templPanel The template panel.

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

GOF_GUIUNITX, GOF_GUIUNITY, GOF_MARGINX, GOF_MARGINY, GOF_OFFSETX, GOF_OFFSETY, GOF_STEPX, GOF_STEPY

Constructor Summary

Constructors

Constructor and Description
GofControlIdentifierAdapter() The constructor is a default constructor without any parameters.

Method Summary

Modifier and Type	Method and Description
void	getControlSettings(IniFile confFile, String subsection) This method should get all the settings from the configuration file needed for this class.
VirtualSessionManager	getVirtualSessionManager(GuiOnTheFlyRuntime gofRuntime) Gets a reference to the VirtualSessionManager.
void	identifyCtrls(GuiOnTheFlyRuntime gofRuntime, GofHostAreaIdentifier areaIdentifier, PhantomHostScreen phantomHostScreen, HostScreen hostScreen, PhantomPanelData newPanel, int offsetX, int offsetY) This method is where the class implementing this interface does all its work.

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.GofControlIdentifier

identifyCtrls

Field Detail

templPanel

protected PhantomPanelData templPanel

The template panel.

Constructor Detail

GofControlIdentifierAdapter

public GofControlIdentifierAdapter()

The constructor is a default constructor without any parameters. This makes it possible to load this class dynamically. The constructor doesn't do anything more than create the instance.

Method Detail

getControlSettings

public void getControlSettings(IniFile confFile,
                               String subsection)

This method should get all the settings from the configuration file needed for this class.

Classes extending from this class that needs to read in their own settings from the configuration file, must implement this method, since this default implementation don't do anything.

Specified by:

getControlSettings in interface GofControlIdentifier

Parameters:

confFile - A reference to the IniFile instance that holds the current server configuration file's settings.

subsection - The name of the subsection used for the current Gui-on-the-Fly settings.

identifyCtrls

public void identifyCtrls(GuiOnTheFlyRuntime gofRuntime,
                          GofHostAreaIdentifier areaIdentifier,
                          PhantomHostScreen phantomHostScreen,
                          HostScreen hostScreen,
                          PhantomPanelData newPanel,
                          int offsetX,
                          int offsetY)

This method is where the class implementing this interface does all its work. The algorithm for identifying the control must be implemented here.

The classes extending from this class should implement the following steps:

• Create PhantomControlBase
• Create PhantomHostField
• Create PhantomControl
• Add the control to PhantomPanelData
• Add the control to the GofHostAreaIdentifier it belongs to
• Mark the GofHostField connected to the new control as processed

This adapter class only implements an empty method. Classes extending this class must extend this method.

Parameters:

gofRuntime - The GuiOnTheFlyRuntime instance.

areaIdentifier - The areaIdentifier in which the controls should be identified.

phantomHostScreen - The Phantom host screen corresponding to the host screen.

hostScreen - The host screen that we are trying to build a GOF panel for.

newPanel - The newly created Gui-on-the-fly runtime panel.

offsetX - The offset in columns for popup window.

offsetY - The offset in lines for popup window.

getVirtualSessionManager

public VirtualSessionManager getVirtualSessionManager(GuiOnTheFlyRuntime gofRuntime)

Gets a reference to the VirtualSessionManager.

Returns:

The VirtualSessionManager.