|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.transform.regions.ScreenRegion
com.ibm.hats.transform.regions.BlockScreenRegion
public class BlockScreenRegion
This class represents a rectangular block screen region, such that if the screen was to be considered a coordinate system of rows and columns, the BlcokScreenRegion representation of the region would own all items for the start to end of each column and row as indicated by the idividual start and end rows and columns.
ScreenRegion| Field Summary |
|---|
| Fields inherited from class com.ibm.hats.transform.regions.ScreenRegion |
|---|
endCol, endRow, startCol, startRow, type |
| Constructor Summary | |
|---|---|
BlockScreenRegion(int startRow,
int startCol,
int endRow,
int endCol)
constructor- sets the region data to the given values |
|
| Method Summary | |
|---|---|
static BlockScreenRegion[] |
blockArrayfromBlockScreenRegion(BlockScreenRegion br)
a static method that creates an array of smaller rectangular regions by dividing the given block region along the rows |
static BlockScreenRegion[] |
blockArrayfromLinearScreenRegion(com.ibm.hats.transform.regions.LinearScreenRegion lr)
a static method that creates an array of smaller rectangular regions by dividing the given linear region along the rows |
Object |
clone()
An abstract method to require overriding of the clone method. |
static ScreenRegion |
compound(ComponentElement[] cea)
override of the ScrenRegion compound method for rectangular operations |
static ScreenRegion |
compound(ScreenRegion[] sr)
ScreenRegion compound method for special linear operations |
int |
endCol()
retrieves the end column |
int |
endRow()
retrieves the end row |
boolean |
equals(BlockScreenRegion sr)
Implementation of equality for ScreenRegion objects. |
boolean |
equals(com.ibm.hats.transform.regions.LinearScreenRegion sr)
implementation of equality for ScreenRegion objects. |
int |
height()
retrieves the height of the rectangle |
boolean |
isInRegion(int row,
int col)
an abstract method for detecting whether a point coordinate is inside the screen region |
int |
size()
an abstract method for determining the amount of single coordinates are inside the screen region |
int |
startCol()
retrieves the start col |
int |
startRow()
retrieves the start row |
String |
toString()
An abstract method to require overriding of the toString method. |
static int |
type()
an override of the ScreenRegion type, always returns the indicator for BlockScreenRegion |
int |
width()
retrieves the width of the rectangle |
| Methods inherited from class com.ibm.hats.transform.regions.ScreenRegion |
|---|
adjustForDefault, compound, equals |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public BlockScreenRegion(int startRow,
int startCol,
int endRow,
int endCol)
startRow - - start row of the linestartCol - - start column of the lineendRow - - end row of the lineendCol - - end column of the line| Method Detail |
|---|
public static BlockScreenRegion[] blockArrayfromLinearScreenRegion(com.ibm.hats.transform.regions.LinearScreenRegion lr)
lr - - the given linear screen region
public static BlockScreenRegion[] blockArrayfromBlockScreenRegion(BlockScreenRegion br)
br - - the given rectangular screen region
public String toString()
ScreenRegion
toString in class ScreenRegionScreenRegion.toString()
public boolean isInRegion(int row,
int col)
ScreenRegion
isInRegion in class ScreenRegionrow - - the row of the coordinatecol - - the column of the coordinate
ScreenRegion.isInRegion(int,int)public int width()
public int height()
public int size()
ScreenRegion
size in class ScreenRegionScreenRegion.size()public int startCol()
public int startRow()
public int endCol()
public int endRow()
public static ScreenRegion compound(ComponentElement[] cea)
cea - - the array of ComponentElements whose consumed screen regions are to be compounded
ScreenRegion.compound(ComponentElement[])public static ScreenRegion compound(ScreenRegion[] sr)
sr - - the array of ScreenRegions who are to be compounded
for a comparisionpublic static int type()
ScreenRegion.type()public Object clone()
ScreenRegion
clone in class ScreenRegionScreenRegion.clone()public boolean equals(BlockScreenRegion sr)
sr - The ScreenRegion to compare against.
true if equal, false otherwise.public boolean equals(com.ibm.hats.transform.regions.LinearScreenRegion sr)
sr - The ScreenRegion to compare against.
true if equal, false otherwise.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||