com.f1j.ss
Class RangeRef

java.lang.Object
  |
  +--com.f1j.ss.RangeRef

public class RangeRef

extends java.lang.Object

This class provides the coordinates of a worksheet range.

Constructor Summary

RangeRef(int row, int col)
Constructs a RangeRef with the specified dimensions.

RangeRef(int row1, int col1, int row2, int col2, Sheet sheet)
Constructs a RangeRef with the specified dimensions.

RangeRef(int row1, int col1, int row2, int col2, Sheet sheet1, Sheet sheet2)
Constructs a RangeRef with the specified dimensions.

RangeRef(int row, int col, Sheet sheet)
Constructs a RangeRef with the specified dimensions.

Method Summary

int	getCol1() Returns the starting column in a worksheet range.
int	getCol2() Returns the ending column in a worksheet range.
int	getRow1() Returns the starting row in a worksheet range.
int	getRow2() Returns the ending row in a worksheet range.
Sheet	getSheet1() Returns the starting sheet in a worksheet range.
Sheet	getSheet2() Returns the ending sheet in a worksheet range.
void	setCol1(int col) Sets the starting column in a worksheet range.
void	setCol2(int col) Sets the ending column in a worksheet range.
void	setRow1(int row) Sets the starting row in a worksheet range.
void	setRow2(int row) Sets the ending row in a worksheet range.

Constructor Detail

RangeRef

public RangeRef(int row,
                int col)

Constructs a RangeRef with the specified dimensions.

Parameters:

row -

col -

RangeRef

public RangeRef(int row1,
                int col1,
                int row2,
                int col2,
                Sheet sheet)

Constructs a RangeRef with the specified dimensions.

Parameters:

row1 -

col1 -

row2 -

col2 -

sheet -

RangeRef

public RangeRef(int row1,
                int col1,
                int row2,
                int col2,
                Sheet sheet1,
                Sheet sheet2)

Constructs a RangeRef with the specified dimensions.

Parameters:

row1 -

col1 -

row2 -

col2 -

sheet1 -

sheet2 -

RangeRef

public RangeRef(int row,
                int col,
                Sheet sheet)

Constructs a RangeRef with the specified dimensions.

Parameters:

row -

col -

sheet -

Method Detail

getCol1

public int getCol1()

Returns the starting column in a worksheet range. Columns are indexed from left to right beginning with 0.

Returns:

an integer identifying the index number of the column.

See Also:

getCol2(), setCol1(int), setCol2(int)

getCol2

public int getCol2()

Returns the ending column in a worksheet range. Columns are indexed from left to right beginning with 0.

Returns:

an integer identifying the index number of the column.

See Also:

getCol1(), setCol1(int), setCol2(int)

getRow1

public int getRow1()

Returns the starting row in a worksheet range. Rows are indexed from top to bottom beginning with 0.

Returns:

an integer identifying the index number of the row.

See Also:

getRow2(), setRow1(int), setRow2(int)

getRow2

public int getRow2()

Returns the ending row in a worksheet range. Rows are indexed from top to bottom beginning with 0.

Returns:

an integer identifying the index number of the row.

See Also:

getRow1(), setRow1(int), setRow2(int)

getSheet1

public Sheet getSheet1()

Returns the starting sheet in a worksheet range. Sheets are indexed from left to right beginning with 0.

Returns:

a Sheet object.

See Also:

getSheet2()

getSheet2

public Sheet getSheet2()

Returns the ending sheet in a worksheet range. Sheets are indexed from left to right beginning with 0.

Returns:

a Sheet object.

See Also:

getSheet1()

setCol1

public void setCol1(int col)

Sets the starting column in a worksheet range. Columns are indexed from left to right beginning with 0.

See Also:

getCol1(), getCol2(), setCol2(int)

setCol2

public void setCol2(int col)

Sets the ending column in a worksheet range. Columns are indexed from left to right beginning with 0.

See Also:

getCol1(), getCol2(), setCol1(int)

setRow1

public void setRow1(int row)

Sets the starting row in a worksheet range. Rows are indexed from top to bottom beginning with 0.

See Also:

getRow1(), getRow2(), setRow2(int)

setRow2

public void setRow2(int row)

Sets the ending row in a worksheet range. Rows are indexed from top to bottom beginning with 0.

See Also:

getRow1(), setRow1(int), setRow2(int)