GofControlIdentifier (NetPhantom® 8.0 Java API Specification)

All Known Implementing Classes:
GofCheckBoxIdentifier, GofComboBoxIdentifier, GofControlIdentifierAdapter, GofEntryFieldIdentifier, GofHorLineIdentifier, GofListBoxIdentifier, GofListContMarkIdentifier, GofOutputTextIdentifier, GofPushButtonIdentifier, GofSpinButtonIdentifier, GofTitleAreaTitleIdentifier
```
public interface GofControlIdentifier
```
The GofControlIdentifier is an interface that must be implemented by all the classes that will be used to identify different controls.
Each of the classes implementing this interface can load their own settings from the configuration file.
The class implementing this interface must have a default constructor, without any parameters, since it will be created dynamically from the class name.
Author:
J. Bergström

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`GOF_GUIUNITX` The unit for Gui-on-the-fly for GUI control positioning in X.
`static int`	`GOF_GUIUNITY` The unit for Gui-on-the-fly for GUI control positioning in Y.
`static int`	`GOF_MARGINX` The margin for Gui-on-the-fly panels on the left and right side.
`static int`	`GOF_MARGINY` The margin for Gui-on-the-fly panels at the top and bottom.
`static int`	`GOF_OFFSETX` How much can be offset before overlapping another field that is also offset in X.
`static int`	`GOF_OFFSETY` How much can be offset before overlapping another field that is also offset in Y.
`static int`	`GOF_STEPX` The inter-line spacing for Gui-on-the-fly controls in X.
`static int`	`GOF_STEPY` The inter-line spacing for Gui-on-the-fly controls in Y.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`getControlSettings(IniFile confFile, String subsection)` This method should read all the settings needed by the control identifier from the configuration file.
`void`	`identifyCtrls(GuiOnTheFlyRuntime gofRuntime, GofHostAreaIdentifier areaIdentifier, PhantomHostScreen phantomHostScreen, HostScreen hostScreen, PhantomPanelData templPanel, PhantomPanelData newPanel, int offsetX, int offsetY)` This method is where the class implementing this interface does all its work.

- Field Detail
  - GOF_GUIUNITX
```
static final int GOF_GUIUNITX
```
    The unit for Gui-on-the-fly for GUI control positioning in X.
    See Also:
    Constant Field Values
  - GOF_GUIUNITY
```
static final int GOF_GUIUNITY
```
    The unit for Gui-on-the-fly for GUI control positioning in Y.
    See Also:
    Constant Field Values
  - GOF_STEPX
```
static final int GOF_STEPX
```
    The inter-line spacing for Gui-on-the-fly controls in X.
    See Also:
    Constant Field Values
  - GOF_STEPY
```
static final int GOF_STEPY
```
    The inter-line spacing for Gui-on-the-fly controls in Y.
    See Also:
    Constant Field Values
  - GOF_MARGINX
```
static final int GOF_MARGINX
```
    The margin for Gui-on-the-fly panels on the left and right side.
    See Also:
    Constant Field Values
  - GOF_MARGINY
```
static final int GOF_MARGINY
```
    The margin for Gui-on-the-fly panels at the top and bottom.
    See Also:
    Constant Field Values
  - GOF_OFFSETX
```
static final int GOF_OFFSETX
```
    How much can be offset before overlapping another field that is also offset in X.
    See Also:
    Constant Field Values
  - GOF_OFFSETY
```
static final int GOF_OFFSETY
```
    How much can be offset before overlapping another field that is also offset in Y.
    See Also:
    Constant Field Values
- Method Detail
  - getControlSettings
```
void getControlSettings(IniFile confFile,
                        String subsection)
```
    This method should read all the settings needed by the control identifier from the configuration file.
    Parameters:
    confFile - The server ini file.
  - identifyCtrls
```
void identifyCtrls(GuiOnTheFlyRuntime gofRuntime,
                   GofHostAreaIdentifier areaIdentifier,
                   PhantomHostScreen phantomHostScreen,
                   HostScreen hostScreen,
                   PhantomPanelData templPanel,
                   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 implementing this interface 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
    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.

Interface GofControlIdentifier

Field Summary

Method Summary

Field Detail

GOF_GUIUNITX

GOF_GUIUNITY

GOF_STEPX

GOF_STEPY

GOF_MARGINX

GOF_MARGINY

GOF_OFFSETX

GOF_OFFSETY

Method Detail

getControlSettings

identifyCtrls