se.entra.phantom.server

Class GofHostField

java.lang.Object

se.entra.phantom.server.GofHostField

public class GofHostField
extends Object

The GofHostFields are wrapper objects for the original host fields. Many of the GofHostFields will correspond directly to a HostField. But sometimes a HostField will be splitted into two ore more GofHostFields, because logically it contains information that are not connected to each other. Typical examples are several output texts that have been written in the same host field with spaces between, because that was more convenient for the developer of the host system.

The GofHostFields are logical host fields that will be used during identification of he different controls.

Author:

J. Bergström

Field Summary

Fields

Modifier and Type	Field and Description
boolean	hasBeenProcessed Flag indicating that this GofHostField has been identified as a control.

Constructor Summary

Constructors

Constructor and Description
GofHostField(HostField hostField, int x, int y, int cx, String text, boolean isEmpty) Creates a new GofHostField.

Method Summary

Modifier and Type	Method and Description
int	getCx() Gets the width of this GofHostField.
HostField	getHostField() Gets this GofHostField's host field.
String	getText() Gets the text of the host field.
int	getX() Gets the start column for this GofHostField.
int	getY() Gets the start line for this GofHostField.
boolean	isEmpty() Gets the value of the flag indicating if the HostField is empty.
boolean	isHidden() Checks if the GofHostField's host field is hidden.
boolean	isProtected() Checks if the GofHostField's host field is protected.
void	setText(String text) Sets the text in this GofHostField.

Methods inherited from class java.lang.Object

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

Field Detail

hasBeenProcessed

public boolean hasBeenProcessed

Flag indicating that this GofHostField has been identified as a control. This flag can be accessed directly.

Constructor Detail

GofHostField

public GofHostField(HostField hostField,
                    int x,
                    int y,
                    int cx,
                    String text,
                    boolean isEmpty)

Creates a new GofHostField.

Parameters:

hostField - The host field that this GofHostField is connected to.

x - The start column for the field.

y - The start line for field.

cx - The length of the field

text - The text in the field.

isEmpty - Flag indicating that the host field is empty;

Method Detail

getHostField

public HostField getHostField()

Gets this GofHostField's host field.

Returns:

The host field.

isProtected

public boolean isProtected()

Checks if the GofHostField's host field is protected.

Returns:

true if the host field is protected, false otherwise.

isHidden

public boolean isHidden()

Checks if the GofHostField's host field is hidden.

Returns:

true if the host field is hidden, false otherwise.

getX

public int getX()

Gets the start column for this GofHostField.

Returns:

The start column (0 based).

getY

public int getY()

Gets the start line for this GofHostField. This is the line that the whole GofHostField is located on.

Returns:

The start line (0 based).

getCx

public int getCx()

Gets the width of this GofHostField.

Returns:

The length in characters.

isEmpty

public boolean isEmpty()

Gets the value of the flag indicating if the HostField is empty.

Returns:

true if the host field is empty, false otherwise.

getText

public String getText()

Gets the text of the host field.

Returns:

The text.

setText

public void setText(String text)

Sets the text in this GofHostField.

Parameters:

text - The new text to set.