se.entra.phantom.server

Class GofHostFieldIdentifierAdapter

java.lang.Object

se.entra.phantom.server.GofHostFieldIdentifierAdapter

All Implemented Interfaces:

GofHostFieldIdentifier

Direct Known Subclasses:

GofAS400HostFieldIdentifier, GofMainFrameHostFieldIdentifier, GofMainFrameSplitHostFieldIdentifier

public abstract class GofHostFieldIdentifierAdapter
extends Object
implements GofHostFieldIdentifier

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

By 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 GofHostFieldIdentifier 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 Vector<GofHostField>	gofHostFields A vector holding all the identified GofHostFields.

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

FLOW_LAYOUT

Constructor Summary

Constructors

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

Method Summary

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 is a method that returns all the GofHostFields on the screen.
Vector<GofHostField>	getPopupWindowHostFields(int x, int y, int w, int h) This is the method to get the GofHostFields belonging to a popup-window.
void	identifyHostFields(HostScreen screen) This method must create the GofHostFields from the HostScreen's HostFields.
boolean	isPartialFieldsIdentified() This methods queries if partial fields are identified when GofHostFields that are partially inside, partially outside the area that should be identified.

Methods inherited from class java.lang.Object

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

Field Detail

gofHostFields

protected Vector<GofHostField> gofHostFields

A vector holding all the identified GofHostFields.

Constructor Detail

GofHostFieldIdentifierAdapter

public GofHostFieldIdentifierAdapter()

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

identifyHostFields

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

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

Specified by:

identifyHostFields in interface GofHostFieldIdentifier

Parameters:

screen - The host screen to process.

doIdentifyPartialFields

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

Specified by:

doIdentifyPartialFields in interface GofHostFieldIdentifier

Parameters:

flag - The value of the flag.

isPartialFieldsIdentified

public boolean isPartialFieldsIdentified()

This methods 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.

Specified by:

isPartialFieldsIdentified in interface GofHostFieldIdentifier

Returns:

true if partial fields are identified, false otherwise.

getHostFields

public Vector<GofHostField> getHostFields(int x,
                                          int y,
                                          int w,
                                          int h)

This method is a method that returns all the GofHostFields on the screen. It takes a start column, start line, width and height as parameters. The parameters determine the actual area of the host field that should be identified, so only GofhostFields inside this area will be returned.

When analyzing if a GofHosField is inside the area, it will take into account the value of the flag doIdentifyPartialFields. If this flag is false, only GofHostFields completely inside the area will be included, otherwise GofHostFields partially inside the area will also be included.

Specified by:

getHostFields in interface GofHostFieldIdentifier

Parameters:

x - The start column.

y - The start row.

w - The width.

h - The height.

Returns:

The logical host fields.

getPopupWindowHostFields

public Vector<GofHostField> getPopupWindowHostFields(int x,
                                                     int y,
                                                     int w,
                                                     int h)

This is the method to get the GofHostFields belonging to a popup-window. It takes a start column, start line, width and height for the popup window as parameters. It first saves the value of the doIdentifyPartialFields flag, sets it to false, since no partial fields should exist in a popup window. It the calls the getHostFields method which retrieves the GofHostFields, and finally restores the doIdentifyPartialFields flag before returning the Vector with the included GofHostFields.

Specified by:

getPopupWindowHostFields in interface GofHostFieldIdentifier

Parameters:

x - The start column.

y - The start row.

w - The width.

h - The height.

Returns:

The logical host fields.