javafx.scene.control

Class TablePosition<S,T>

java.lang.Object

javafx.scene.control.TablePositionBase<TableColumn<S,T>>

javafx.scene.control.TablePosition<S,T>

Type Parameters:

S - The type of the items contained within the TableView (i.e. the same generic type as the S in TableView<S>).

T - The type of the items contained within the TableColumn.

public class TablePosition<S,T>
extends TablePositionBase<TableColumn<S,T>>

This class is used to represent a single row/column/cell in a TableView. This is used throughout the TableView API to represent which rows/columns/cells are currently selected, focused, being edited, etc. Note that this class is immutable once it is created.

Because the TableView can have different selection modes, the row and column properties in TablePosition can be 'disabled' to represent an entire row or column. This is done by setting the unrequired property to -1 or null.

Since:

JavaFX 2.0

See Also:

TableView, TableColumn

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.ref.WeakReference<TableView<S>>	controlRef * Instance Variables * *
(package private) int	fixedColumnIndex
private java.lang.ref.WeakReference<S>	itemRef
private int	nonFixedColumnIndex

Constructor Summary

Constructors

Constructor and Description
TablePosition(TableView<S> tableView, int row, TableColumn<S,T> tableColumn) Constructs a TablePosition instance to represent the given row/column position in the given TableView instance.

Method Summary

Modifier and Type	Method and Description
int	getColumn() The column index that this TablePosition represents in the TableView.
(package private) S	getItem() Returns the item that backs the TablePositionBase.getRow() row}, at the point in time when this TablePosition was created.
TableColumn<S,T>	getTableColumn() The TableColumn that this TablePosition represents in the TableView.
TableView<S>	getTableView() The TableView that this TablePosition is related to.
java.lang.String	toString() Returns a string representation of this TablePosition object.

Methods inherited from class javafx.scene.control.TablePositionBase

equals, getRow, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

controlRef

private final java.lang.ref.WeakReference<TableView<S>> controlRef

* Instance Variables * *

itemRef

private final java.lang.ref.WeakReference<S> itemRef

fixedColumnIndex

int fixedColumnIndex

nonFixedColumnIndex

private final int nonFixedColumnIndex

Constructor Detail

TablePosition

public TablePosition(TableView<S> tableView,
                     int row,
                     TableColumn<S,T> tableColumn)

Constructs a TablePosition instance to represent the given row/column position in the given TableView instance. Both the TableView and TableColumn are referenced weakly in this class, so it is possible that they will be null when their respective getters are called.

Parameters:

tableView - The TableView that this position is related to.

row - The row that this TablePosition is representing.

tableColumn - The TableColumn instance that this TablePosition represents.

Method Detail

getColumn

public int getColumn()

The column index that this TablePosition represents in the TableView. It is -1 if the TableView or TableColumn instances are null at the time the class is instantiated (i.e. it is computed at construction).

Specified by:

getColumn in class TablePositionBase<TableColumn<S,T>>

Returns:

the column index that this TablePosition represents in the TableView

getTableView

public final TableView<S> getTableView()

The TableView that this TablePosition is related to.

Returns:

the TableView

getTableColumn

public final TableColumn<S,T> getTableColumn()

The TableColumn that this TablePosition represents in the TableView.

Overrides:

getTableColumn in class TablePositionBase<TableColumn<S,T>>

Returns:

the TableColumn that this TablePosition represents in the TableView

getItem

final S getItem()

Returns the item that backs the TablePositionBase.getRow() row}, at the point in time when this TablePosition was created.

toString

public java.lang.String toString()

Returns a string representation of this TablePosition object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this TablePosition object.