GofHostFieldIdentifier (NetPhantom® 8.0 Java API Specification)

All Known Implementing Classes:
GofAS400HostFieldIdentifier, GofHostFieldIdentifierAdapter, GofMainFrameHostFieldIdentifier, GofMainFrameSplitHostFieldIdentifier
```
public interface GofHostFieldIdentifier
```
This interface must be implemented by classes that are used to create logical host fields, called GofHostFields, from a screen's host fields. This makes it possible to split original host fields into two or more logical host fields, which might simplify the identification of controls.
This might be done when a host field wraps from one line to another line, or when several uneditable list cells are included in one single host field, as is normal on main frames.
Author:
J. Bergström

Field Summary
Fields
Modifier and Type Field and Description
static int FLOW_LAYOUT
Constant for specifying a flow layout.

Fields
Modifier and Type	Field and Description
`static int`	`FLOW_LAYOUT` Constant for specifying a flow layout.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`doIdentifyPartialFields(boolean flag)` This method must store a flag indicating what should be done with GofHostFields that are partially inside, partially outside the area that should be identified.
`Vector<GofHostField>`	`getHostFields(int x, int y, int w, int h)` This method retrieves the GofHostFields created in the identifyHostFields method.
`Vector<GofHostField>`	`getPopupWindowHostFields(int x, int y, int w, int h)` This method retrieves the GofHostFields created in the identifyHostFields method, that are inside a popup window.
`void`	`identifyHostFields(HostScreen screen)` This method must create the GofHostFields from the HostScreen's HostFields.
`boolean`	`isPartialFieldsIdentified()` This method queries if partial fields are identified when GofHostFields that are partially inside, partially outside the area that should be identified.

- Field Detail
  - FLOW_LAYOUT
```
static final int FLOW_LAYOUT
```
    Constant for specifying a flow layout.
    See Also:
    Constant Field Values
- Method Detail
  - identifyHostFields
```
void identifyHostFields(HostScreen screen)
```
    This method must create the GofHostFields from the HostScreen's HostFields. It is up this method to decide if a HostField should be split up to several GofHostFields. The newly created GofHostFields must be stored internally in the class, since the method GetHostFields must be able to return them.
    Parameters:
    screen - The host screen to process.
  - doIdentifyPartialFields
```
void doIdentifyPartialFields(boolean flag)
```
    This method must store a flag indicating what should be done with GofHostFields that are partially inside, partially outside the area that should be identified. This flag is only meaningful when a part of the whole screen will be identified.
    Parameters:
    flag - The value of the flag.
  - isPartialFieldsIdentified
```
boolean isPartialFieldsIdentified()
```
    This method queries if partial fields are identified when GofHostFields that are partially inside, partially outside the area that should be identified. The returned value is only meaningful when a part of the whole screen will be identified.
    Returns:
    true if partial fields are identified, false otherwise.
  - getHostFields
```
Vector<GofHostField> getHostFields(int x,
                                   int y,
                                   int w,
                                   int h)
```
    This method retrieves the GofHostFields created in the identifyHostFields method. It should take in account the value of the flag that was set in the doIdentifyPartialFields method.
    Parameters:
    x - The start column.
    y - The start row.
    w - The width.
    h - The height.
    Returns:
    The logical host fields.
  - getPopupWindowHostFields
```
Vector<GofHostField> getPopupWindowHostFields(int x,
                                              int y,
                                              int w,
                                              int h)
```
    This method retrieves the GofHostFields created in the identifyHostFields method, that are inside a popup window. It should ignore the value of the flag that was set in the doIdentifyPartialFields method, since this should only be valid for complete screens.
    Parameters:
    x - The start column.
    y - The start row.
    w - The width.
    h - The height.
    Returns:
    The logical host fields.

Interface GofHostFieldIdentifier

Field Summary

Method Summary

Field Detail

FLOW_LAYOUT

Method Detail

identifyHostFields

doIdentifyPartialFields

isPartialFieldsIdentified

getHostFields

getPopupWindowHostFields