Package io.keikai.api

Class AreaRefWithType

java.lang.Object

io.keikai.api.AreaRef

io.keikai.api.AreaRefWithType

All Implemented Interfaces:

Serializable

public class AreaRefWithType
extends AreaRef

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) and an extra selection type. (CELL, COL, ROW, ALL)

Since:

3.8.3

Author:

Henri Chen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected CellSelectionType	_type

Fields inherited from class io.keikai.api.AreaRef

_column, _lastColumn, _lastRow, _row

Constructor Summary

Constructors

Constructor	Description
AreaRefWithType(int row, int column, int lastRow, int lastColumn, CellSelectionType type)
AreaRefWithType(String areaReference, CellSelectionType type)

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)
CellSelectionType	getSelType()
int	hashCode()
boolean	overlap(int bTopRow, int bLeftCol, int bBottomRow, int bRightCol)
boolean	overlap(AreaRefWithType areaRef)
void	setSelType(CellSelectionType type)

Methods inherited from class io.keikai.api.AreaRef

getColumn, getLastColumn, getLastRow, getRow, setArea, setColumn, setLastColumn, setLastRow, setRow, toString

Methods inherited from class java.lang.Object

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

Field Detail

_type

protected CellSelectionType _type

Constructor Detail

AreaRefWithType

public AreaRefWithType(int row,
                       int column,
                       int lastRow,
                       int lastColumn,
                       CellSelectionType type)

AreaRefWithType

public AreaRefWithType(String areaReference,
                       CellSelectionType type)

Method Detail

cloneSelf

public AreaRef cloneSelf()

Overrides:

cloneSelf in class AreaRef

contains

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

Overrides:

contains in class AreaRef

overlap

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

Overrides:

overlap in class AreaRef

overlap

public boolean overlap(AreaRefWithType areaRef)

asString

public String asString()

Overrides:

asString in class AreaRef

Returns:

reference string, e.x A1:B2

hashCode

public int hashCode()

Overrides:

hashCode in class AreaRef

equals

public boolean equals(Object obj)

Overrides:

equals in class AreaRef

setSelType

public void setSelType(CellSelectionType type)

Parameters:

type -

Since:

3.8.3

getSelType

public CellSelectionType getSelType()

Returns:

Since:

3.8.3