Package docking.widgets.fieldpanel.support

Class FieldLocation

java.lang.Object

docking.widgets.fieldpanel.support.FieldLocation

All Implemented Interfaces:

java.lang.Comparable<FieldLocation>

public class FieldLocation
extends java.lang.Object
implements java.lang.Comparable<FieldLocation>

Class to represent locations within the FieldViewer.

Field Summary

Fields

Modifier and Type	Field	Description
int	col
int	fieldNum
static FieldLocation	MAX
int	row

Constructor Summary

Constructors

Constructor	Description
FieldLocation()
FieldLocation(int index)
FieldLocation(int index, int fieldNum)
FieldLocation(int index, int fieldNum, int row, int col)	Construct a new FieldLocation with the given index,fieldNum,row, and col.
FieldLocation(FieldLocation loc)	Construct a new FieldLocation by copying from another FieldLocation.
FieldLocation(java.math.BigInteger index)
FieldLocation(java.math.BigInteger index, int fieldNum)
FieldLocation(java.math.BigInteger index, int fieldNum, int row, int col)
FieldLocation(org.jdom.Element child)

Method Summary

Modifier and Type	Method	Description
int	compareTo(FieldLocation o)
boolean	equals(java.lang.Object obj)
int	getCol()	Returns the column within the Field for this location.
org.jdom.Element	getElement(java.lang.String name)
int	getFieldNum()	Returns the field index for this location.
java.math.BigInteger	getIndex()
int	getRow()	Returns the row within the Field for this location.
int	hashCode()
void	set(FieldLocation loc)
void	setIndex(java.math.BigInteger index)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX

public static final FieldLocation MAX

fieldNum

public int fieldNum

row

public int row

col

public int col

Constructor Detail

FieldLocation

public FieldLocation()

FieldLocation

public FieldLocation(int index)

FieldLocation

public FieldLocation(int index,
                     int fieldNum)

FieldLocation

public FieldLocation(java.math.BigInteger index)

FieldLocation

public FieldLocation(java.math.BigInteger index,
                     int fieldNum)

FieldLocation

public FieldLocation(int index,
                     int fieldNum,
                     int row,
                     int col)

Construct a new FieldLocation with the given index,fieldNum,row, and col.

Parameters:

index - the index of the layout containing the location

fieldNum - the index of the field in the layout containing the location

row - the text row in the field containing the location.

col - the character position the row containing the location.

FieldLocation

public FieldLocation(java.math.BigInteger index,
                     int fieldNum,
                     int row,
                     int col)

FieldLocation

public FieldLocation(org.jdom.Element child)

FieldLocation

public FieldLocation(FieldLocation loc)

Construct a new FieldLocation by copying from another FieldLocation.

Parameters:

loc - the FieldLocation to be copied.

Method Detail

getIndex

public java.math.BigInteger getIndex()

getFieldNum

public int getFieldNum()

Returns the field index for this location.

getRow

public int getRow()

Returns the row within the Field for this location.

getCol

public int getCol()

Returns the column within the Field for this location.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

compareTo

public int compareTo(FieldLocation o)

Specified by:

compareTo in interface java.lang.Comparable<FieldLocation>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getElement

public org.jdom.Element getElement(java.lang.String name)

set

public void set(FieldLocation loc)

setIndex

public void setIndex(java.math.BigInteger index)