ControlsFX 11.2.2 · impl.org.controlsfx.spreadsheet.TableViewSpanSelectionModel

Field Summary

Modifier and Type	Field and Description
private SpreadsheetGridView	cellsView
public Pair<Integer, Integer>	direction
private boolean	drag
private final EventHandler<MouseEvent>	dragDoneHandler When the drag is over, we remove the listener and stop the timer
private boolean	key
private final EventHandler<KeyEvent>	keyPressedEventHandler
private final ListChangeListener<TablePosition<ObservableList<SpreadsheetCell>, ?>>	listChangeListener
private boolean	makeAtomic
private MouseEvent	mouseEvent
private final EventHandler<MouseEvent>	mousePressedEventHandler
private TablePosition<ObservableList<SpreadsheetCell>, ?>	old ******************************************************************** Public selection API * * *******************************************************************
private int	oldColSpan
private int	oldRow
private int	oldRowSpan
private TableColumn<S, T>	oldTableColumn We use these variable in order to stay on the same row/column when navigating with arrows.
private final EventHandler<MouseEvent>	onDragDetectedEventHandler
private final EventHandler<MouseEvent>	onMouseDragEventHandler
private final SelectedCellsMapTemp<TablePosition<ObservableList<SpreadsheetCell>, ?>>	selectedCellsMap
private final ReadOnlyUnbackedObservableList<TablePosition<ObservableList<SpreadsheetCell>, ?>>	selectedCellsSeq
private boolean	shift
private SpreadsheetView	spreadsheetView
private final Timeline	timer Make the tableView move when selection operating outside bounds
private final EventHandler<ActionEvent>	timerEventHandler

Constructor Summary

Access	Constructor and Description
public	TableViewSpanSelectionModel(SpreadsheetView spreadsheetView, SpreadsheetGridView cellsView) Constructor

Method Summary

Modifier and Type	Method and Description
private void	addSelectedRowsAndColumns(TablePosition<?, ?> pos) ******************************************************************** Support code * * *******************************************************************
public void	clearAndSelect(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.clearAndSelect. Clears all selection, and then selects the cell at the given row/column intersection.
public void	clearSelection(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.clearSelection. Removes selection from the specified row/column position (in view indexes).
public void	clearSelection() Overrides javafx.scene.control.MultipleSelectionModelBase.clearSelection. Clears the selection model of all selected indices.
pack-priv final GridViewSkin	getCellsViewSkin() Returns: the inner table view skin
private TablePosition<ObservableList<SpreadsheetCell>, ?>	getFocusedCell() Hides javafx.scene.control.TableView.TableViewSelectionModel.getFocusedCell.
private GridRow	getNonFixedRow(int index) Return the `GridRow` at the specified index
public ObservableList<TablePosition<S, T>>	getSelectedCells() Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.getSelectedCells. FIXME I don't understand why TablePosition is not parameterized in the API..
private GridViewSkin	getSpreadsheetViewSkin()
private TableColumn<ObservableList<SpreadsheetCell>, ?>	getTableColumn(TableColumn<ObservableList<SpreadsheetCell>, ?> column, int offset)
private TablePosition<ObservableList<SpreadsheetCell>, ?>	getVisibleCell(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) For a position, return the Visible Cell associated with It can be the top of the span cell if it's visible, or it can be the first row visible if we have scrolled
private void	handleSelectedCellsListChangeEvent(ListChangeListener.Change<? extends TablePosition<ObservableList<SpreadsheetCell>, ?>> c)
public boolean	isSelected(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.isSelected. Convenience function which tests whether the given row and column index is currently selected in this table instance.
public List<TablePosition<ObservableList<SpreadsheetCell>, ?>>	isSelectedRange(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column, int col) Return the tablePosition of a selected cell inside a spanned cell if any.
private void	quietClearSelection() Hides javafx.scene.control.MultipleSelectionModelBase.quietClearSelection.
private void	removeSelectedRowsAndColumns(TablePosition<?, ?> pos)
public void	select(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.select. Selects the cell at the given row/column intersection.
public void	selectAboveCell() Implements abstract javafx.scene.control.TableSelectionModel.selectAboveCell. Selects the cell directly above the currently selected cell.
public void	selectAll() Overrides javafx.scene.control.MultipleSelectionModelBase.selectAll. Convenience method to select all available indices.
public void	selectBelowCell() Implements abstract javafx.scene.control.TableSelectionModel.selectBelowCell. Selects the cell directly below the currently selected cell.
public void	selectLeftCell() Implements abstract javafx.scene.control.TableSelectionModel.selectLeftCell. Selects the cell to the left of the currently selected cell.
public void	selectRange(int minRow, TableColumnBase<ObservableList<SpreadsheetCell>, ?> minColumn, int maxRow, TableColumnBase<ObservableList<SpreadsheetCell>, ?> maxColumn) Overrides javafx.scene.control.TableView.TableViewSelectionModel.selectRange. Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), inclusive.
public void	selectRightCell() Implements abstract javafx.scene.control.TableSelectionModel.selectRightCell. Selects the cell to the right of the currently selected cell.
private void	updateScroll(TablePosition<ObservableList<SpreadsheetCell>, ?> posFinal) We try to make visible the rows that may be hidden by Fixed rows.
private void	updateSelectedVisuals(GridViewSkin skin, TablePosition<S, T> pos, HashSet<Integer> selectedRows, HashSet<Integer> selectedColumns) When all the selection has been made, we just need to light up the indicators that are showing which indexes are selected.
public void	verifySelectedCells(List<Pair<Integer, Integer>> selectedCells) When we set a new grid, we need to update the selected Cells because otherwise we will end up with TablePosition which have "-1" as their column number.

Inherited from javafx.scene.control.TableView.TableViewSelectionModel:: clearAndSelect clearSelection focus getFocusedIndex getItemCount getModelItem getTableModel getTableView isSelected select

Field Detail

cellsView	back to summary
private SpreadsheetGridView cellsView

direction	back to summary
public Pair<Integer, Integer> direction

drag	back to summary
private boolean drag

dragDoneHandler	back to summary
private final EventHandler<MouseEvent> dragDoneHandler When the drag is over, we remove the listener and stop the timer

key	back to summary
private boolean key

keyPressedEventHandler	back to summary
private final EventHandler<KeyEvent> keyPressedEventHandler

listChangeListener	back to summary
private final ListChangeListener<TablePosition<ObservableList<SpreadsheetCell>, ?>> listChangeListener

makeAtomic	back to summary
private boolean makeAtomic

mouseEvent	back to summary
private MouseEvent mouseEvent

mousePressedEventHandler	back to summary
private final EventHandler<MouseEvent> mousePressedEventHandler

old	back to summary
private TablePosition<ObservableList<SpreadsheetCell>, ?> old ******************************************************************** Public selection API * * *******************************************************************

oldColSpan	back to summary
private int oldColSpan

oldRow	back to summary
private int oldRow

oldRowSpan	back to summary
private int oldRowSpan

oldTableColumn	back to summary
private TableColumn<S, T> oldTableColumn We use these variable in order to stay on the same row/column when navigating with arrows. If we are going down, and we are arriving on a column-spanning cell, when going down again, we don't want to go on the starting column of the spanning cell but on the same column we arrived previously.

onDragDetectedEventHandler	back to summary
private final EventHandler<MouseEvent> onDragDetectedEventHandler

onMouseDragEventHandler	back to summary
private final EventHandler<MouseEvent> onMouseDragEventHandler

selectedCellsMap	back to summary
private final SelectedCellsMapTemp<TablePosition<ObservableList<SpreadsheetCell>, ?>> selectedCellsMap

selectedCellsSeq	back to summary
private final ReadOnlyUnbackedObservableList<TablePosition<ObservableList<SpreadsheetCell>, ?>> selectedCellsSeq

shift	back to summary
private boolean shift

spreadsheetView	back to summary
private SpreadsheetView spreadsheetView

timer	back to summary
private final Timeline timer Make the tableView move when selection operating outside bounds

timerEventHandler	back to summary
private final EventHandler<ActionEvent> timerEventHandler

Constructor Detail

TableViewSpanSelectionModel	back to summary
public TableViewSpanSelectionModel(SpreadsheetView spreadsheetView, SpreadsheetGridView cellsView) Constructor

Method Detail

addSelectedRowsAndColumns	back to summary
private void addSelectedRowsAndColumns(TablePosition<?, ?> pos) ******************************************************************** Support code * * *******************************************************************

clearAndSelect	back to summary
public void clearAndSelect(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.clearAndSelect. Doc from javafx.scene.control.TableView.TableViewSelectionModel.clearAndSelect. Clears all selection, and then selects the cell at the given row/column intersection. Annotations @Override

clearAndSelect

back to summary

public void clearAndSelect(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column)

Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.clearAndSelect.

Doc from javafx.scene.control.TableView.TableViewSelectionModel.clearAndSelect.

Clears all selection, and then selects the cell at the given row/column intersection.

Annotations

@Override

clearSelection	back to summary
public void clearSelection(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.clearSelection. Doc from javafx.scene.control.TableView.TableViewSelectionModel.clearSelection. Removes selection from the specified row/column position (in view indexes). If this particular cell (or row if the column value is -1) is not selected, nothing happens. Annotations @SuppressWarnings:unchecked @Override

clearSelection

back to summary

public void clearSelection(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column)

Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.clearSelection.

Doc from javafx.scene.control.TableView.TableViewSelectionModel.clearSelection.

Removes selection from the specified row/column position (in view indexes). If this particular cell (or row if the column value is -1) is not selected, nothing happens.

Annotations

@SuppressWarnings:unchecked
@Override

clearSelection	back to summary
public void clearSelection() Overrides javafx.scene.control.MultipleSelectionModelBase.clearSelection. Doc from javafx.scene.control.SelectionModel.clearSelection. Clears the selection model of all selected indices. Annotations @Override

clearSelection

back to summary

public void clearSelection()

Overrides javafx.scene.control.MultipleSelectionModelBase.clearSelection.

Doc from javafx.scene.control.SelectionModel.clearSelection.

Clears the selection model of all selected indices.

Annotations

@Override

getCellsViewSkin	back to summary
pack-priv final GridViewSkin getCellsViewSkin() Returns:GridViewSkin the inner table view skin

getFocusedCell	back to summary
private TablePosition<ObservableList<SpreadsheetCell>, ?> getFocusedCell() Hides javafx.scene.control.TableView.TableViewSelectionModel.getFocusedCell. Annotations @SuppressWarnings:unchecked

getFocusedCell

back to summary

private TablePosition<ObservableList<SpreadsheetCell>, ?> getFocusedCell()

Hides javafx.scene.control.TableView.TableViewSelectionModel.getFocusedCell.

Annotations

@SuppressWarnings:unchecked

getNonFixedRow	back to summary
private GridRow getNonFixedRow(int index) Return the `GridRow` at the specified index

getSelectedCells	back to summary
public ObservableList<TablePosition<S, T>> getSelectedCells() Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.getSelectedCells. FIXME I don't understand why TablePosition is not parameterized in the API.. Annotations @Override

getSelectedCells

back to summary

public ObservableList<TablePosition<S, T>> getSelectedCells()

Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.getSelectedCells.

FIXME I don't understand why TablePosition is not parameterized in the API..

Annotations

@Override

getSpreadsheetViewSkin	back to summary
private GridViewSkin getSpreadsheetViewSkin()

getTableColumn	back to summary
private TableColumn<ObservableList<SpreadsheetCell>, ?> getTableColumn(TableColumn<ObservableList<SpreadsheetCell>, ?> column, int offset)

getVisibleCell	back to summary
private TablePosition<ObservableList<SpreadsheetCell>, ?> getVisibleCell(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) For a position, return the Visible Cell associated with It can be the top of the span cell if it's visible, or it can be the first row visible if we have scrolled

handleSelectedCellsListChangeEvent	back to summary
private void handleSelectedCellsListChangeEvent(ListChangeListener.Change<? extends TablePosition<ObservableList<SpreadsheetCell>, ?>> c)

isSelected	back to summary
public boolean isSelected(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.isSelected. Doc from javafx.scene.control.TableView.TableViewSelectionModel.isSelected. Convenience function which tests whether the given row and column index is currently selected in this table instance. Annotations @Override

isSelected

back to summary

public boolean isSelected(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column)

Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.isSelected.

Doc from javafx.scene.control.TableView.TableViewSelectionModel.isSelected.

Convenience function which tests whether the given row and column index is currently selected in this table instance.

Annotations

@Override

isSelectedRange	back to summary
public List<TablePosition<ObservableList<SpreadsheetCell>, ?>> isSelectedRange(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column, int col) Return the tablePosition of a selected cell inside a spanned cell if any.

quietClearSelection	back to summary
private void quietClearSelection() Hides javafx.scene.control.MultipleSelectionModelBase.quietClearSelection.

removeSelectedRowsAndColumns	back to summary
private void removeSelectedRowsAndColumns(TablePosition<?, ?> pos)

select	back to summary
public void select(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column) Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.select. Doc from javafx.scene.control.TableView.TableViewSelectionModel.select. Selects the cell at the given row/column intersection. Annotations @Override

select

back to summary

public void select(int row, TableColumn<ObservableList<SpreadsheetCell>, ?> column)

Implements abstract javafx.scene.control.TableView.TableViewSelectionModel.select.

Doc from javafx.scene.control.TableView.TableViewSelectionModel.select.

Selects the cell at the given row/column intersection.

Annotations

@Override

selectAboveCell	back to summary
public void selectAboveCell() Implements abstract javafx.scene.control.TableSelectionModel.selectAboveCell. Doc from javafx.scene.control.TableSelectionModel.selectAboveCell. Selects the cell directly above the currently selected cell. Annotations @Override

selectAboveCell

back to summary

public void selectAboveCell()

Implements abstract javafx.scene.control.TableSelectionModel.selectAboveCell.

Doc from javafx.scene.control.TableSelectionModel.selectAboveCell.

Selects the cell directly above the currently selected cell.

Annotations

@Override

selectAll	back to summary
public void selectAll() Overrides javafx.scene.control.MultipleSelectionModelBase.selectAll. Doc from javafx.scene.control.MultipleSelectionModel.selectAll. Convenience method to select all available indices. Annotations @Override

selectAll

back to summary

public void selectAll()

Overrides javafx.scene.control.MultipleSelectionModelBase.selectAll.

Doc from javafx.scene.control.MultipleSelectionModel.selectAll.

Convenience method to select all available indices.

Annotations

@Override

selectBelowCell	back to summary
public void selectBelowCell() Implements abstract javafx.scene.control.TableSelectionModel.selectBelowCell. Doc from javafx.scene.control.TableSelectionModel.selectBelowCell. Selects the cell directly below the currently selected cell. Annotations @Override

selectBelowCell

back to summary

public void selectBelowCell()

Implements abstract javafx.scene.control.TableSelectionModel.selectBelowCell.

Doc from javafx.scene.control.TableSelectionModel.selectBelowCell.

Selects the cell directly below the currently selected cell.

Annotations

@Override

selectLeftCell	back to summary
public void selectLeftCell() Implements abstract javafx.scene.control.TableSelectionModel.selectLeftCell. Doc from javafx.scene.control.TableSelectionModel.selectLeftCell. Selects the cell to the left of the currently selected cell. Annotations @Override

selectLeftCell

back to summary

public void selectLeftCell()

Implements abstract javafx.scene.control.TableSelectionModel.selectLeftCell.

Doc from javafx.scene.control.TableSelectionModel.selectLeftCell.

Selects the cell to the left of the currently selected cell.

Annotations

@Override

selectRange	back to summary
public void selectRange(int minRow, TableColumnBase<ObservableList<SpreadsheetCell>, ?> minColumn, int maxRow, TableColumnBase<ObservableList<SpreadsheetCell>, ?> maxColumn) Overrides javafx.scene.control.TableView.TableViewSelectionModel.selectRange. Doc from javafx.scene.control.TableView.TableViewSelectionModel.selectRange. Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), inclusive. Annotations @Override

selectRange

back to summary

public void selectRange(int minRow, TableColumnBase<ObservableList<SpreadsheetCell>, ?> minColumn, int maxRow, TableColumnBase<ObservableList<SpreadsheetCell>, ?> maxColumn)

Overrides javafx.scene.control.TableView.TableViewSelectionModel.selectRange.

Doc from javafx.scene.control.TableView.TableViewSelectionModel.selectRange.

Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), inclusive.

Annotations

@Override

selectRightCell	back to summary
public void selectRightCell() Implements abstract javafx.scene.control.TableSelectionModel.selectRightCell. Doc from javafx.scene.control.TableSelectionModel.selectRightCell. Selects the cell to the right of the currently selected cell. Annotations @Override

selectRightCell

back to summary

public void selectRightCell()

Implements abstract javafx.scene.control.TableSelectionModel.selectRightCell.

Doc from javafx.scene.control.TableSelectionModel.selectRightCell.

Selects the cell to the right of the currently selected cell.

Annotations

@Override

updateScroll	back to summary
private void updateScroll(TablePosition<ObservableList<SpreadsheetCell>, ?> posFinal) We try to make visible the rows that may be hidden by Fixed rows.

updateSelectedVisuals	back to summary
private void updateSelectedVisuals(GridViewSkin skin, TablePosition<S, T> pos, HashSet<Integer> selectedRows, HashSet<Integer> selectedColumns) When all the selection has been made, we just need to light up the indicators that are showing which indexes are selected.

verifySelectedCells	back to summary
public void verifySelectedCells(List<Pair<Integer, Integer>> selectedCells) When we set a new grid, we need to update the selected Cells because otherwise we will end up with TablePosition which have "-1" as their column number. So we need to verify that the old selected cells are still selectable and select them.

public Class TableViewSpanSelectionModel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail