Package io.keikai.api

Class AreaRef

java.lang.Object

io.keikai.api.AreaRef

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AreaRefWithType, MergedRect

public class AreaRef
extends Object
implements Serializable

A class that represents an area reference with 4 value : row(top row), column(left column), last row(bottom row) and last column(right column)

Since:

3.0.0

Author:

Dennis.Chen

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	_column
protected int	_lastColumn
protected int	_lastRow
protected int	_row

Constructor Summary

Constructors

Constructor	Description
AreaRef()
AreaRef(int row, int column, int lastRow, int lastColumn)
AreaRef(String areaReference)

Method Summary

Modifier and Type	Method	Description
String	asString()
AreaRef	cloneSelf()
boolean	contains(int tRow, int lCol, int bRow, int rCol)
boolean	equals(Object obj)
int	getColumn()
int	getLastColumn()
int	getLastRow()
int	getRow()
int	hashCode()
boolean	overlap(int bTopRow, int bLeftCol, int bBottomRow, int bRightCol)
void	setArea(int row, int column, int lastRow, int lastColumn)
void	setColumn(int column)
void	setLastColumn(int lastColumn)
void	setLastRow(int lastRow)
void	setRow(int row)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

_column

protected int _column

_row

protected int _row

_lastColumn

protected int _lastColumn

_lastRow

protected int _lastRow

Constructor Details

AreaRef

public AreaRef()

AreaRef

public AreaRef(int row,
 int column,
 int lastRow,
 int lastColumn)

AreaRef

public AreaRef(String areaReference)

Method Details

setArea

public void setArea(int row,
 int column,
 int lastRow,
 int lastColumn)

getColumn

public int getColumn()

setColumn

public void setColumn(int column)

getRow

public int getRow()

setRow

public void setRow(int row)

getLastColumn

public int getLastColumn()

setLastColumn

public void setLastColumn(int lastColumn)

getLastRow

public int getLastRow()

setLastRow

public void setLastRow(int lastRow)

cloneSelf

public AreaRef cloneSelf()

contains

public boolean contains(int tRow,
 int lCol,
 int bRow,
 int rCol)

overlap

public boolean overlap(int bTopRow,
 int bLeftCol,
 int bBottomRow,
 int bRightCol)

asString

public String asString()

Returns:

reference string, e.x A1:B2

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object