org.dhatim.fastexcel

Class Range

java.lang.Object

org.dhatim.fastexcel.Range

public class Range
extends Object

Definition of a range of cells.

Method Summary

Modifier and Type	Method and Description
static String	colToString(int c) Convert a column index to a column name.
boolean	contains(int r, int c) Check if this range contains the given cell coordinates.
boolean	equals(Object obj)
int	getBottom() Get bottom row.
int	getLeft() Get left column.
int	getRight() Get right column.
int	getTop() Get top row.
Worksheet	getWorksheet() Get parent worksheet.
int	hashCode()
void	merge() Merge cells within this range.
void	setName(String name) Specifically define this range by assigning it a name.
StyleSetter	style() Get a new style setter for this range.
String	toAbsoluteString() Get an absolute reference to this Range.
String	toString()
ListDataValidation	validateWithList(Range listRange) Construct a new ListDataValidation

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getWorksheet

public Worksheet getWorksheet()

Get parent worksheet.

Returns:

Parent worksheet.

getTop

public int getTop()

Get top row.

Returns:

Top row.

getLeft

public int getLeft()

Get left column.

Returns:

Left column.

getBottom

public int getBottom()

Get bottom row.

Returns:

Bottom row.

getRight

public int getRight()

Get right column.

Returns:

Right column.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

colToString

public static String colToString(int c)

Convert a column index to a column name.

Parameters:

c - Zero-based column index.

Returns:

Column name.

toString

public String toString()

Overrides:

toString in class Object

toAbsoluteString

public String toAbsoluteString()

Get an absolute reference to this Range. ex: $A$1:$A$5

Returns:

absolute reference

style

public StyleSetter style()

Get a new style setter for this range.

Returns:

Newly created style setter.

merge

public void merge()

Merge cells within this range.

contains

public boolean contains(int r,
                        int c)

Check if this range contains the given cell coordinates.

Parameters:

r - Zero-based row number.

c - Zero-based column number.

Returns:

true if this range contains the given cell coordinates.

validateWithList

public ListDataValidation validateWithList(Range listRange)

Construct a new ListDataValidation

Parameters:

listRange - The Range of the list this validation references

Returns:

a new list data validation object

setName

public void setName(String name)

Specifically define this range by assigning it a name. It will be visible in the cell range dropdown menu.

Parameters:

name - string representing the name of this cell range