io.starter.formats.XLS

Interface Ref

public interface Ref

Ref defines an OpenXLS record or object that represents a range of cell locations.

See Also:

Ptg, Formula

Field Summary

Fields

Modifier and Type	Field and Description
static int	PTG_LOCATION_POLICY_LOCKED
static int	PTG_LOCATION_POLICY_TRACK
static int	PTG_LOCATION_POLICY_UNLOCKED

Method Summary

Modifier and Type	Method and Description
int[]	getIntLocation()
String	getLocation() When the ptg is a reference to a location this returns that location
int	getLocationPolicy() returns whether the Location of the Ptg is locked used during automated BiffRec movement updates
String	getLocationWithSheet() returns the String address of this ptg including sheet reference
int[]	getRowCol() returns the row/col ints for the ref
String	getSheetName() gets the sheetname for this ref
void	setLocation(String s) setLocation moves a ptg that is a reference to a location, such as a ptg range being modified
void	setLocationPolicy(int b) lock the Location of the Ptg so that it will not be updated during automated BiffRec movement updates

Field Detail

PTG_LOCATION_POLICY_UNLOCKED

static final int PTG_LOCATION_POLICY_UNLOCKED

See Also:

Constant Field Values

PTG_LOCATION_POLICY_LOCKED

static final int PTG_LOCATION_POLICY_LOCKED

See Also:

Constant Field Values

PTG_LOCATION_POLICY_TRACK

static final int PTG_LOCATION_POLICY_TRACK

See Also:

Constant Field Values

Method Detail

getLocationPolicy

int getLocationPolicy()

returns whether the Location of the Ptg is locked used during automated BiffRec movement updates

Returns:

location policy

setLocationPolicy

void setLocationPolicy(int b)

lock the Location of the Ptg so that it will not be updated during automated BiffRec movement updates

Parameters:

b - whether to lock the location of this Ptg

setLocation

void setLocation(String s)

setLocation moves a ptg that is a reference to a location, such as a ptg range being modified

Parameters:

String - location, such as A1:D4

getLocation

String getLocation()
            throws FormulaNotFoundException

When the ptg is a reference to a location this returns that location

Returns:

String Location

Throws:

FormulaNotFoundException

getIntLocation

int[] getIntLocation()
              throws FormulaNotFoundException

Throws:

FormulaNotFoundException

getRowCol

int[] getRowCol()

returns the row/col ints for the ref

Returns:

the row col int array

getLocationWithSheet

String getLocationWithSheet()

returns the String address of this ptg including sheet reference

Returns:

the String location of the reference including sheetname

getSheetName

String getSheetName()
             throws WorkSheetNotFoundException

gets the sheetname for this ref

Parameters:

sheetname -

Throws:

WorkSheetNotFoundException