HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.regions
Class ScreenRegion

java.lang.Object
  extended by com.ibm.hats.transform.regions.ScreenRegion
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
BlockScreenRegion

public abstract class ScreenRegion
extends Object
implements Cloneable

this is abstract class is used to represent a contigous region of host screen coordinates

See Also:
Cloneable

Field Summary
 int endCol
          The ending column of the screen region
 int endRow
          The ending row of the screen region
 int startCol
          The starting column of the screen region
 int startRow
          The starting row of the screen region
 int type
          an indicator of the type of region that the implemenation chooses
 
Constructor Summary
ScreenRegion()
           
 
Method Summary
 void adjustForDefault(HsrScreen hs)
          a method for adjusting the screen region to fit with in the confines of a given host screen.
abstract  Object clone()
          An abstract method to require overriding of the clone method.
static ScreenRegion compound(ComponentElement[] ce)
          a method for detecting finding the compound area of the consumed regions of ComponentElements
static ScreenRegion compound(ComponentElement[] ce, int hscolsize)
           
static ScreenRegion compound(ScreenRegion[] sr)
          a method for detecting finding the compound area of multiple ScreenRegions
 boolean equals(ScreenRegion sr)
          implementation of equality for ScreenRegion objects
abstract  boolean isInRegion(int row, int col)
          an abstract method for detecting whether a point coordinate is inside the screen region
abstract  int size()
          an abstract method for determining the amount of single coordinates are inside the screen region
abstract  String toString()
          An abstract method to require overriding of the toString method.
static int type()
          An indicator of the type of region that the implemenation chooses.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

startRow

public int startRow
The starting row of the screen region


startCol

public int startCol
The starting column of the screen region


endRow

public int endRow
The ending row of the screen region


endCol

public int endCol
The ending column of the screen region


type

public int type
an indicator of the type of region that the implemenation chooses

Constructor Detail

ScreenRegion

public ScreenRegion()
Method Detail

isInRegion

public abstract boolean isInRegion(int row,
                                   int col)
an abstract method for detecting whether a point coordinate is inside the screen region

Parameters:
row - - the row of the coordinate
col - - the column of the coordinate
Returns:
boolean matches - if the coordinate is encompassed by the region, the value returned is true

size

public abstract int size()
an abstract method for determining the amount of single coordinates are inside the screen region

Returns:
int size - the amount of coordinates encompassed by the screen region

compound

public static ScreenRegion compound(ComponentElement[] ce)
a method for detecting finding the compound area of the consumed regions of ComponentElements

Parameters:
ce - - the array of ComponentElements whose consumed screen regions are to be compounded
Returns:
ScreenRegion regionSum - the screen region consumed by the total of the ComponentElements

compound

public static ScreenRegion compound(ComponentElement[] ce,
                                    int hscolsize)

toString

public abstract String toString()
An abstract method to require overriding of the toString method.

Overrides:
toString in class Object
Returns:
The screen region information in a user discernable form

type

public static int type()
An indicator of the type of region that the implemenation chooses.


compound

public static ScreenRegion compound(ScreenRegion[] sr)
a method for detecting finding the compound area of multiple ScreenRegions

Parameters:
sr - - the array of ScreenRegions who are to be compounded
Returns:
ScreenRegion regionSum - the screen region consumed by the total of the ScreenRegions

adjustForDefault

public void adjustForDefault(HsrScreen hs)
a method for adjusting the screen region to fit with in the confines of a given host screen.

Parameters:
hs - The host screen to adjsut the region to fit within.

clone

public abstract Object clone()
An abstract method to require overriding of the clone method.

Overrides:
clone in class Object
Returns:
The region information in a new object.

equals

public boolean equals(ScreenRegion sr)
implementation of equality for ScreenRegion objects

Parameters:
sr - - the ScreenRegion to compare against
Returns:
boolean

HATS 7.5.1 (201005110649)