com.wrq.apptrieve.appconn
Class ElementLocation

java.lang.Object
  com.wrq.apptrieve.appconn.ElementLocation

public class ElementLocation
extends java.lang.Object

ElementLocation provides location information about a particular Host Integrator entity attribute, pattern, recordset field, or recordset.

Field Summary

static int	ELEMENT_TYPE_ATTRIBUTE Return value of getElementType() when element is an attribute.
static int	ELEMENT_TYPE_FIELD Return value of getElementType() when element is a field.
static int	ELEMENT_TYPE_PATTERN Return value of getElementType() when element is a pattern.
static int	ELEMENT_TYPE_RECORDSET Return value of getElementType() when element is a recordset.
static int	ELEMENT_TYPE_UNKNOWN Return value of getElementType() when element is unknown.
static int	REGION_TYPE_LINEAR Return value of getRegionType() when the region is linear.
static int	REGION_TYPE_RECTANGULAR Return value of getRegionType() when the region is rectangular.
static int	REGION_TYPE_UNKNOWN Return value of getRegionType() when the region type is unknown.

Constructor Summary

ElementLocation(ElementLoc saObject)
Constructor for internal use only.

Method Summary

java.lang.String	getElementName() Gets the name of the location element.
int	getElementType() Gets the type of element.
int	getLeftColumn() Gets the left column character position of the element's screen region.
int	getLength() Gets the length of the element's screen region, starting with the region's offset.
int	getNumColumns() Gets the number of columns included the element's screen region.
int	getNumRows() Gets the number of rows included the element's screen region.
int	getOffset() Gets the character offset to the start of the element's screen region, starting with the top-left corner of the screen.
int	getRegionType() Gets the region type for the element.
int	getTopRow() Gets the top row character position of the element's screen region.
java.lang.String	toString() Generates a String that represents the current values of this TerminalAttributes object.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_TYPE_ATTRIBUTE

public static final int ELEMENT_TYPE_ATTRIBUTE

Return value of getElementType() when element is an attribute.

See Also:

Constant Field Values

ELEMENT_TYPE_PATTERN

public static final int ELEMENT_TYPE_PATTERN

Return value of getElementType() when element is a pattern.

See Also:

Constant Field Values

ELEMENT_TYPE_FIELD

public static final int ELEMENT_TYPE_FIELD

Return value of getElementType() when element is a field.

See Also:

Constant Field Values

ELEMENT_TYPE_RECORDSET

public static final int ELEMENT_TYPE_RECORDSET

Return value of getElementType() when element is a recordset.

See Also:

Constant Field Values

ELEMENT_TYPE_UNKNOWN

public static final int ELEMENT_TYPE_UNKNOWN

Return value of getElementType() when element is unknown.

See Also:

Constant Field Values

REGION_TYPE_LINEAR

public static final int REGION_TYPE_LINEAR

Return value of getRegionType() when the region is linear.

See Also:

Constant Field Values

REGION_TYPE_RECTANGULAR

public static final int REGION_TYPE_RECTANGULAR

Return value of getRegionType() when the region is rectangular.

See Also:

Constant Field Values

REGION_TYPE_UNKNOWN

public static final int REGION_TYPE_UNKNOWN

Return value of getRegionType() when the region type is unknown.

See Also:

Constant Field Values

Constructor Detail

ElementLocation

public ElementLocation(ElementLoc saObject)

Constructor for internal use only.

Parameters:

saObject - data

Method Detail

getElementName

public java.lang.String getElementName()

Gets the name of the location element.

Returns:

java.lang.String - the name of the element as defined in the Host Integrator model

getElementType

public int getElementType()

Gets the type of element.

This can be one of the following:

• ELEMENT_TYPE_ATTRIBUTE - an entity attribute
• ELEMENT_TYPE_PATTERN - an entity pattern
• ELEMENT_TYPE_FIELD - a recordset field
• ELEMENT_TYPE_RECORDSET - a recordset
• ELEMENT_TYPE_UNKNOWN - unknown element

Returns:

int - the element type

getTopRow

public int getTopRow()

Gets the top row character position of the element's screen region.

Applies to rectangular elements only.

Returns:

int - the top row position, -1 if type is not rectangular

getLeftColumn

public int getLeftColumn()

Gets the left column character position of the element's screen region.

Applies to rectangular elements only.

Returns:

int - the left column position, -1 if type is not rectangular

getNumRows

public int getNumRows()

Gets the number of rows included the element's screen region.

Applies to rectangular elements only.

Returns:

int - the number of rows, -1 if type is not rectangular

getNumColumns

public int getNumColumns()

Gets the number of columns included the element's screen region.

Applies to rectangular elements only.

Returns:

int - the number of columns, -1 if type is not rectangular

getOffset

public int getOffset()

Gets the character offset to the start of the element's screen region, starting with the top-left corner of the screen.

Applies to linear elements only.

Returns:

int - the offset, -1 if type is not linear

getLength

public int getLength()

Gets the length of the element's screen region, starting with the region's offset.

Applies to linear elements only.

Returns:

int - the length in characters, -1 if type is not linear

getRegionType

public int getRegionType()

Gets the region type for the element.

This can be one of the following:

• REGION_TYPE_LINEAR - a linear screen region
• REGION_TYPE_RECTANGULAR - a rectangular screen region
• REGION_TYPE_UNKNOWN - unknown region type

Returns:

int - the region type

toString

public java.lang.String toString()

Generates a String that represents the current values of this TerminalAttributes object.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String - the string representation of this object