Foxit PDF SDK  9.1
com.foxit.sdk.common.fxcrt.RectI Class Reference

Public Member Functions

void setLeft (int value)
 Set the left. More...
 
int getLeft ()
 Get the left. More...
 
void setTop (int value)
 Set the top. More...
 
int getTop ()
 Get the top. More...
 
void setRight (int value)
 Set the right. More...
 
int getRight ()
 Get the right. More...
 
void setBottom (int value)
 Set the bottom. More...
 
int getBottom ()
 Get the bottom. More...
 
 RectI ()
 Construct a rect not initialized.

 
 RectI (int left1, int top1, int right1, int bottom1)
 Construct a rect with left-top and right bottom corners.
More...
 
int width ()
 Get the width of the rect.
More...
 
int height ()
 Get the height of the rect.
More...
 
boolean isEmpty ()
 Verify whether the rect is empty.
More...
 
void normalize ()
 Normalize the rect. Make sure left <= right, top <= bottom.
More...
 
void intersect (RectI src)
 Intersect with a rect.
More...
 
void intersect (int left1, int top1, int right1, int bottom1)
 Intersect with a rect.
More...
 
void union (RectI other_rect)
 Union with a rect.
More...
 
void offset (int dx, int dy)
 Shift the coordinates by delta value of x and y directions.
More...
 
boolean contains (RectI other_rect)
 Check if current rectangle fully contains the other provided rectangle. That means to check if the other rectangle is fully inside current one.
More...
 
boolean contains (int x, int y)
 Check if current rectangle contains the provided point. That means to check if the provided point is inside current one.
More...
 
boolean valid ()
 Check if current rectangle is valid.
More...
 

Detailed Description

The struct represents integer rectangle for Windows coordinates. Defined as equivalent of Windows RECT structure, with some convenient function members. This structure use Windows space where Y axis runs from top to bottom.

Constructor & Destructor Documentation

◆ RectI()

com.foxit.sdk.common.fxcrt.RectI.RectI ( int  left1,
int  top1,
int  right1,
int  bottom1 
)

Construct a rect with left-top and right bottom corners.

Parameters
[in]left1The left.
[in]top1The top.
[in]right1The right.
[in]bottom1The bottom.

Member Function Documentation

◆ contains() [1/2]

boolean com.foxit.sdk.common.fxcrt.RectI.contains ( int  x,
int  y 
)

Check if current rectangle contains the provided point. That means to check if the provided point is inside current one.

Parameters
[in]xThe x coordinate of the provided point.
[in]yThe y coordinate of the provided point.
Returns
true means current rect contains the provided point, while false means not.

◆ contains() [2/2]

boolean com.foxit.sdk.common.fxcrt.RectI.contains ( RectI  other_rect)

Check if current rectangle fully contains the other provided rectangle. That means to check if the other rectangle is fully inside current one.

Parameters
[in]other_rectThe other provided rect.
Returns
true means current rect fully contains the other rectangle, while false means not.

◆ getBottom()

com.foxit.sdk.common.fxcrt.RectI.getBottom ( )

Get the bottom.

Returns
The bottom.

◆ getLeft()

com.foxit.sdk.common.fxcrt.RectI.getLeft ( )

Get the left.

Returns
The left.

◆ getRight()

com.foxit.sdk.common.fxcrt.RectI.getRight ( )

Get the right.

Returns
The right.

◆ getTop()

com.foxit.sdk.common.fxcrt.RectI.getTop ( )

Get the top.

Returns
The top.

◆ height()

int com.foxit.sdk.common.fxcrt.RectI.height ( )

Get the height of the rect.

Returns
The height of the rect.

◆ intersect() [1/2]

void com.foxit.sdk.common.fxcrt.RectI.intersect ( int  left1,
int  top1,
int  right1,
int  bottom1 
)

Intersect with a rect.

Parameters
[in]left1The left of the rect to intersect with.
[in]top1The top of the rect to intersect with.
[in]right1The right of the rect to intersect with.
[in]bottom1The bottom of the rect to intersect with.
Returns
None.

◆ intersect() [2/2]

void com.foxit.sdk.common.fxcrt.RectI.intersect ( RectI  src)

Intersect with a rect.

Parameters
[in]srcThe rect to intersect with.
Returns
None.

◆ isEmpty()

boolean com.foxit.sdk.common.fxcrt.RectI.isEmpty ( )

Verify whether the rect is empty.

Returns
true means current rect is empty, while false means not.

◆ normalize()

void com.foxit.sdk.common.fxcrt.RectI.normalize ( )

Normalize the rect. Make sure left <= right, top <= bottom.

Returns
None.

◆ offset()

void com.foxit.sdk.common.fxcrt.RectI.offset ( int  dx,
int  dy 
)

Shift the coordinates by delta value of x and y directions.

Parameters
[in]dxThe delta value of x-direction.
[in]dyThe delta value of y-direction.
Returns
None.

◆ setBottom()

com.foxit.sdk.common.fxcrt.RectI.setBottom ( int  value)

Set the bottom.

Parameters
[in]valueThe bottom.
Returns
None.

◆ setLeft()

com.foxit.sdk.common.fxcrt.RectI.setLeft ( int  value)

Set the left.

Parameters
[in]valueThe left.
Returns
None.

◆ setRight()

com.foxit.sdk.common.fxcrt.RectI.setRight ( int  value)

Set the right.

Parameters
[in]valueThe right.
Returns
None.

◆ setTop()

com.foxit.sdk.common.fxcrt.RectI.setTop ( int  value)

Set the top.

Parameters
[in]valueThe top.
Returns
None.

◆ union()

void com.foxit.sdk.common.fxcrt.RectI.union ( RectI  other_rect)

Union with a rect.

Parameters
[in]other_rectThe rect to union with.
Returns
None.

◆ valid()

boolean com.foxit.sdk.common.fxcrt.RectI.valid ( )

Check if current rectangle is valid.

Returns
true means valid, while false means invalid.

◆ width()

int com.foxit.sdk.common.fxcrt.RectI.width ( )

Get the width of the rect.

Returns
The width of the rect.