Module org.controlsfx.controls
Package org.controlsfx.control.spreadsheet

Interface Grid

  • All Known Implementing Classes:
    GridBase
    public interface Grid
    That class holds some SpreadsheetCell in order to be used by the SpreadsheetView. A Grid is used by SpreadsheetView to represent the data to show on screen. A default implementation is provided by GridBase, but for more custom purposes (e.g. loading data on demand), this Grid interface may prove useful.

    A Grid at its essence consists of rows and columns. Critical to the SpreadsheetView is that the row count and column count are accurately returned when requested (even if the data returned by getRows() is not all fully loaded into memory).

    Whilst the getRows() return type may appear confusing, it is actually quite logical when you think about it: getRows() returns an ObservableList of ObservableList of SpreadsheetCell instances. In other words, this is your classic 2D collection, where the outer ObservableList can be thought of as the rows, and the inner ObservableList as the columns within each row. Therefore, if you are wanting to iterate through all columns in every row of the grid, you would do something like this:

    Code Sample 

     Grid grid = ...
 for (int row = 0; row < grid.getRowCount(); row++) {
     for (int column = 0; column < grid.getColumnCount(); column++) {
         SpreadsheetCell<?> cell = getRows().get(row).get(column);
         doStuff(cell);
     }
 }
    See Also:
    SpreadsheetView, GridBase, SpreadsheetCell

    • Method Detail

      • getRowCount

        int getRowCount()
        Returns how many rows are inside the Grid.
        Returns:
        the number of rows in the Grid.

      • getColumnCount

        int getColumnCount()
        Returns how many columns are inside the Grid.
        Returns:
        the number of columns in the Grid.

      • setCellValue

        void setCellValue​(int row,
                  int column,
                  Object value)
        Changes the value situated at the intersection if possible. Verification and conversion of the value should be done before with SpreadsheetCellType.match(Object) and SpreadsheetCellType.convertValue(Object).
        Parameters:
        row - the row index issued from the SpreadsheetCell
        column - the column index issued from the SpreadsheetCell
        value - the value to set to the SpreadsheetCell

      • getRowHeight

        double getRowHeight​(int row)
        Returns the height of a row. AUTOFIT can be returned in order to let the system compute the best row height.
        Parameters:
        row - the row index
        Returns:
        the height in pixels of the given row.

      • isRowResizable

        boolean isRowResizable​(int row)
        Returns true if the specified row is resizable.
        Parameters:
        row - the row index
        Returns:
        true if the specified row is resizable

      • getRowHeaders

        ObservableList<String> getRowHeaders()
        Returns an ObservableList of String to display in the row headers.
        Returns:
        an ObservableList of String to display in the row headers

      • getColumnHeaders

        ObservableList<String> getColumnHeaders()
        Returns an ObservableList of String to display in the column headers.
        Returns:
        an ObservableList of String to display in the column headers

      • spanRow

        void spanRow​(int count,
             int rowIndex,
             int colIndex)
        Spans in row the cell situated at rowIndex and colIndex by the number count.
        Parameters:
        count - the span range
        rowIndex - the row index
        colIndex - the column index

      • spanColumn

        void spanColumn​(int count,
                int rowIndex,
                int colIndex)
        Spans in column the cell situated at rowIndex and colIndex by the number count.
        Parameters:
        count - the span range
        rowIndex - the row index
        colIndex - the column index

      • isDisplaySelection

        boolean isDisplaySelection()
        Return true if the selection (black rectangle) is displayed on the Grid. Cells may override this property with setCellDisplaySelection(int, int, boolean).
        Returns:
        true if the selection (black rectangle) is displayed on the Grid

      • setDisplaySelection

        void setDisplaySelection​(boolean value)
        If set to true, the selection (black rectangle) will be displayed on the Grid. Cells may override this property with setCellDisplaySelection(int, int, boolean).
        Parameters:
        value - true if the selection should be displayed

      • setCellDisplaySelection

        void setCellDisplaySelection​(int row,
                             int column,
                             boolean displaySelection)
        Overrides the value defined by isDisplaySelection() so that no matter what is defined on the grid, the given cell will always have its selection set to the displaySelection parameter.
        Parameters:
        row - the row index
        column - the column index
        displaySelection - true is the selection should always be displayed on this cell

      • isCellDisplaySelection

        boolean isCellDisplaySelection​(int row,
                               int column)
        Returns true if the given cell will display a selection rectangle when selected. If nothing is defined for this cell, isDisplaySelection() is returned.
        Parameters:
        row - the row index
        column - the column index
        Returns:
        true if the given cell will display a selection rectangle

      • addEventHandler

        <E extends GridChange> void addEventHandler​(EventType<E> eventType,
                                            EventHandler<E> eventHandler)
        Registers an event handler to this Grid. The Grid class allows registration of listeners which will be notified as a SpreadsheetCell's value will change.
        Type Parameters:
        E -
        Parameters:
        eventType - the type of the events to receive by the handler
        eventHandler - the handler to register
        Throws:
        NullPointerException - if the event type or handler is null

      • removeEventHandler

        <E extends GridChange> void removeEventHandler​(EventType<E> eventType,
                                               EventHandler<E> eventHandler)
        Unregisters a previously registered event handler from this Grid. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.
        Type Parameters:
        E -
        Parameters:
        eventType - the event type from which to unregister
        eventHandler - the handler to unregister
        Throws:
        NullPointerException - if the event type or handler is null