Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.ken.engines.data.BoundingRect Class Reference

The BoundingRect object holds four integer edge coordinates for a rectangle. More...

Public Member Functions

 BoundingRect ()
 Public Constructors. More...
 
 BoundingRect (BoundingRect r)
 Create a new BoundingRect, with the coordinates copied from the specified BoundingRect. More...
 
 BoundingRect (int left, int top, int right, int bottom)
 
int getRectBottom ()
 Get the bottom coordinate of the BoundingRect. More...
 
void setRectBottom (int bottom)
 Set the bottom coordinate of the BoundingRect. More...
 
int getRectLeft ()
 Get the left coordinate of the BoundingRect. More...
 
void setRectLeft (int left)
 Set the left coordinate of the BoundingRect. More...
 
int getRectRight ()
 Get the right coordinate of the BoundingRect. More...
 
void setRectRight (int right)
 Set the right coordinate of the BoundingRect. More...
 
int getRectTop ()
 Get the top coordinate of the BoundingRect. More...
 
void setRectTop (int top)
 Set the top coordinate of the BoundingRect. More...
 
int height ()
 Public Methods. More...
 
void set (int left, int top, int right, int bottom)
 Set this BoundingRect's coordinates to the specified values. More...
 
void set (BoundingRect src)
 Copy the coordinates from src into this BoundingRect. More...
 
void setEmpty ()
 Set this BoundingRect to (0,0,0,0). More...
 
String toString ()
 Returns a string containing a concise, human-readable description of this object. More...
 
int width ()
 Returns calculated width of the BoundingRect. More...
 

Detailed Description

The BoundingRect object holds four integer edge coordinates for a rectangle.

The rectangle consists of the coordinates of its left, top, right, and bottom edges. These edge coordinates are available through accessor methods.

Constructor & Destructor Documentation

com.kofax.kmc.ken.engines.data.BoundingRect.BoundingRect ( )
inline

Public Constructors.

Create a new empty BoundingRect.

com.kofax.kmc.ken.engines.data.BoundingRect.BoundingRect ( BoundingRect  r)
inline

Create a new BoundingRect, with the coordinates copied from the specified BoundingRect.

com.kofax.kmc.ken.engines.data.BoundingRect.BoundingRect ( int  left,
int  top,
int  right,
int  bottom 
)
inline

Member Function Documentation

int com.kofax.kmc.ken.engines.data.BoundingRect.getRectBottom ( )
inline

Get the bottom coordinate of the BoundingRect.

int com.kofax.kmc.ken.engines.data.BoundingRect.getRectLeft ( )
inline

Get the left coordinate of the BoundingRect.

int com.kofax.kmc.ken.engines.data.BoundingRect.getRectRight ( )
inline

Get the right coordinate of the BoundingRect.

int com.kofax.kmc.ken.engines.data.BoundingRect.getRectTop ( )
inline

Get the top coordinate of the BoundingRect.

int com.kofax.kmc.ken.engines.data.BoundingRect.height ( )
inline

Public Methods.

Returns calculated height of the BoundingRect.

void com.kofax.kmc.ken.engines.data.BoundingRect.set ( int  left,
int  top,
int  right,
int  bottom 
)
inline

Set this BoundingRect's coordinates to the specified values.

void com.kofax.kmc.ken.engines.data.BoundingRect.set ( BoundingRect  src)
inline

Copy the coordinates from src into this BoundingRect.

void com.kofax.kmc.ken.engines.data.BoundingRect.setEmpty ( )
inline

Set this BoundingRect to (0,0,0,0).

void com.kofax.kmc.ken.engines.data.BoundingRect.setRectBottom ( int  bottom)
inline

Set the bottom coordinate of the BoundingRect.

void com.kofax.kmc.ken.engines.data.BoundingRect.setRectLeft ( int  left)
inline

Set the left coordinate of the BoundingRect.

void com.kofax.kmc.ken.engines.data.BoundingRect.setRectRight ( int  right)
inline

Set the right coordinate of the BoundingRect.

void com.kofax.kmc.ken.engines.data.BoundingRect.setRectTop ( int  top)
inline

Set the top coordinate of the BoundingRect.

String com.kofax.kmc.ken.engines.data.BoundingRect.toString ( )
inline

Returns a string containing a concise, human-readable description of this object.

int com.kofax.kmc.ken.engines.data.BoundingRect.width ( )
inline

Returns calculated width of the BoundingRect.


The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.