com.googlecode.leptonica.android

Class Box

java.lang.Object

com.googlecode.leptonica.android.Box

public class Box
extends Object

Wrapper for Leptonica's native BOX.

Author:

alanv@google.com (Alan Viverette)

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEX_H The index of the height within the geometry array.
static int	INDEX_W The index of the width within the geometry array.
static int	INDEX_X The index of the X coordinate within the geometry array.
static int	INDEX_Y The index of the Y coordinate within the geometry array.

Constructor Summary

Constructors

Constructor and Description
Box(int x, int y, int w, int h) Creates a box with the specified geometry.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finalize()
int[]	getGeometry() Returns an array containing the coordinates of this box.
boolean	getGeometry(int[] geometry) Fills an array containing the coordinates of this box.
int	getHeight() Returns the box's height in pixels.
int	getWidth() Returns the box's width in pixels.
int	getX() Returns the box's x-coordinate in pixels.
int	getY() Returns the box's y-coordinate in pixels.
void	recycle() Releases resources and frees any memory associated with this Box.

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_X

public static final int INDEX_X

The index of the X coordinate within the geometry array.

See Also:

Constant Field Values

INDEX_Y

public static final int INDEX_Y

The index of the Y coordinate within the geometry array.

See Also:

Constant Field Values

INDEX_W

public static final int INDEX_W

The index of the width within the geometry array.

See Also:

Constant Field Values

INDEX_H

public static final int INDEX_H

The index of the height within the geometry array.

See Also:

Constant Field Values

Constructor Detail

Box

public Box(int x,
   int y,
   int w,
   int h)

Creates a box with the specified geometry. All dimensions should be non-negative and specified in pixels.

Parameters:

x - X-coordinate of the top-left corner of the box.

y - Y-coordinate of the top-left corner of the box.

w - Width of the box.

h - Height of the box.

Method Detail

getX

public int getX()

Returns the box's x-coordinate in pixels.

Returns:

The box's x-coordinate in pixels.

getY

public int getY()

Returns the box's y-coordinate in pixels.

Returns:

The box's y-coordinate in pixels.

getWidth

public int getWidth()

Returns the box's width in pixels.

Returns:

The box's width in pixels.

getHeight

public int getHeight()

Returns the box's height in pixels.

Returns:

The box's height in pixels.

getGeometry

public int[] getGeometry()

Returns an array containing the coordinates of this box. See INDEX_* constants for indices.

Returns:

an array of box oordinates

getGeometry

public boolean getGeometry(int[] geometry)

Fills an array containing the coordinates of this box. See INDEX_* constants for indices.

Parameters:

geometry - A 4+ element integer array to fill with coordinates.

Returns:

true on success

recycle

public void recycle()

Releases resources and frees any memory associated with this Box.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable