The SpreadsheetView is a control similar to the JavaFX TableView control but with different functionalities and use cases. The aim is to have a powerful grid where data can be written and retrieved.

Features

• Cells can span in row and in column.
• Rows can be frozen to the top of the SpreadsheetView so that they are always visible on screen.
• Columns can be frozen to the left of the SpreadsheetView so that they are always visible on screen.
• A row header can be switched on in order to display the row number.
• Rows can be resized just like columns with click & drag.
• Both row and column header can be visible or invisible.
• Selection of several cells can be made with a click and drag.
• A copy/paste context menu is accessible with a right-click. The usual shortcuts are also working.
• Picker can be placed above column header or to the side of the row header.
• Rows and columns can be hidden (like Excel grouping).
• Zoom in and out in order for the SpreadsheetView to fit on a monitor.
• Rows can be sorted using a Comparator.

Freezing Rows and Columns

You can freeze some rows and some columns by right-clicking on their header. A context menu will appear if it's possible to freeze them. When frozen, the label header will then be in italic and the background will turn to dark grey.
You have also the possibility to freeze them manually by adding and removing items from getFixedRows() and getFixedColumns(). But you are strongly advised to check if it's possible to do so with SpreadsheetColumn#isColumnFixable() for the frozen columns and with isRowFixable(int) for the frozen rows.
A set of rows cannot be frozen if any cell inside these rows has a row span superior to the number of frozen rows. Likewise, a set of columns cannot be frozen if any cell inside these columns has a column span superior to the number of frozen columns.

If you want to freeze several rows or columns together, and they have a span inside, you can call areRowsFixable(java.util.List) or areSpreadsheetColumnsFixable(java.util.List) to verify if you can freeze them. Be sure to add them all in once otherwise the system will detect that a span is going out of bounds and will throw an exception. Calling those methods prior every move will ensure that no exception will be thrown.

You have also the possibility to deactivate these possibilities. For example, you force some row/column to be frozen and then the user cannot change the settings.

Headers

You can also access and toggle header's visibility by using the methods provided like setShowRowHeader(boolean) or setShowColumnHeader(boolean).
Users can double-click on a column header will resize the column to the best size in order to fully see each cell in it. Same rule apply for row header. Also note that double-clicking on the little space between two row or two columns (when resizable) will also work just like Excel.

Pickers

You can show some little images next to the headers. They will appear on the left of the VerticalHeader and on top on the HorizontalHeader. They are called "picker" because they were used originally for picking a row or a column to insert in the SpreadsheetView.
But you can do anything you want with it. Simply put a row or a column index in getRowPickers() and getColumnPickers() along with an instance of Picker. You can override the Picker#onClick() method in order to react when the user click on the picker.
The pickers will appear on the top of the column's header and on the left of the row's header.
For example, here is a picker displayed for a row that allow to group rows like Excel:

Once we clicked on the picker (minus sign), the rows are hidden.

Here is the code related to the images :

Picker picker = new Picker() {
         @Override
         public void onClick() {
         //If my details are hidden
             if (getHiddenRows().get(3)) {
                 showRow(3);
                 showRow(4);
                 showRow(5);
                 showRow(6);
             } else {
                 hideRow(3);
                 hideRow(4);
                 hideRow(5);
                 hideRow(6);
             }
         }
};
getRowPickers().put(2, picker);

Copy pasting

You can copy any cell you want and paste it elsewhere. Be aware that only the value inside will be pasted, not the style nor the type. Thus the value you're trying to paste must be compatible with the SpreadsheetCellType of the receiving cell. Pasting a Double into a String will work but the reverse operation will not.
See SpreadsheetCellType Value Verification documentation for more information.
A unique cell or a selection can be copied and pasted.

Hiding rows and columns

Rows and columns can be hidden if you need to. Simply call showRow(int) or hideRow(int) in order to toggle the visibility of a row. Same for the column.
Note that the span of the cell (in row or column) will automatically adapt based on the visible rows or columns. You have nothing to do.
Because toggling visibility have an impact on the Grid, if you have a lot of rows/columns to show or hide, you may consider setting them all directly by using setHiddenRows(java.util.BitSet). The BitSet represent all your rows/columns and the bit associated to it represent its visibility.

Zoom

The SpreadsheetView offers the possibility to zoom in or out. This is useful when you have a second monitor and you want your whole grid to fit in. Or when you want to draw the attention on a particular portion of the grid.
You can modify the zoom factor by playing with setZoomFactor(java.lang.Double). We recommend using value between 2 and 0.1.
Also note that the SpreadsheetView is configured to react when CTRL + and CTRL - are triggered by, respectively, zooming in and zooming out by 10%. Also CTRL 0 will bring the zoom back to default (1).

Code Samples

Just like the TableView, you instantiate the underlying model, a Grid. You will create some rows filled with SpreadsheetCell.

int rowCount = 15;
    int columnCount = 10;
    GridBase grid = new GridBase(rowCount, columnCount);

    ObservableList<ObservableList<SpreadsheetCell>> rows = FXCollections.observableArrayList();
    for (int row = 0; row < grid.getRowCount(); ++row) {
        final ObservableList<SpreadsheetCell> list = FXCollections.observableArrayList();
        for (int column = 0; column < grid.getColumnCount(); ++column) {
            list.add(SpreadsheetCellType.STRING.createCell(row, column, 1, 1,"value"));
        }
        rows.add(list);
    }
    grid.setRows(rows);

    SpreadsheetView spv = new SpreadsheetView(grid);

At that moment you can span some of the cells with the convenient method provided by the grid. Then you just need to instantiate the SpreadsheetView.

Visual: