Package org.eclipse.nebula.widgets.nattable.selection

Interface ISelectionModel

    • Method Detail

      • isMultipleSelectionAllowed

        boolean isMultipleSelectionAllowed()
        Determines whether multiple cells can be selected simultaneously
        Returns:
        whether multiple cells can be selected simultaneously

      • setMultipleSelectionAllowed

        void setMultipleSelectionAllowed​(boolean multipleSelectionAllowed)
        Sets whether multiple cells can be selected simultaneously
        Parameters:
        multipleSelectionAllowed - whether multiple cells can be selected simultaneously

      • addSelection

        void addSelection​(int columnPosition,
                  int rowPosition)
        Selects a specified cell
        Parameters:
        columnPosition - column position of the cell to select
        rowPosition - row position of the cell to select

      • addSelection

        void addSelection​(org.eclipse.swt.graphics.Rectangle range)
        Selects the cells of a specified area
        Parameters:
        range - the position based area to select

      • clearSelection

        void clearSelection()
        Removes all cell selections

      • clearSelection

        void clearSelection​(int columnPosition,
                    int rowPosition)
        Deselects a specified cell
        Parameters:
        columnPosition - column position of the cell to deselect
        rowPosition - row position of the cell to deselect

      • clearSelection

        void clearSelection​(org.eclipse.swt.graphics.Rectangle removedSelection)
        Removes the selection of specified cells
        Parameters:
        removedSelection - the position based area to deselect

      • isEmpty

        boolean isEmpty()
        Determines whether there are any selected cells
        Returns:
        whether there are any selected cells

      • getSelections

        List<org.eclipse.swt.graphics.Rectangle> getSelections()
        Retrieves the cells that are selected
        Returns:
        the cells that are selected, expressed in position coordinates

      • isCellPositionSelected

        boolean isCellPositionSelected​(int columnPosition,
                               int rowPosition)
        Determines whether a specified cell is selected
        Parameters:
        columnPosition - column position of the cell to inspect
        rowPosition - row position of the cell to inspect
        Returns:
        whether the specified cell is selected

      • getSelectedColumnPositions

        int[] getSelectedColumnPositions()
        Retrieves the columns that have any selected cells
        Returns:
        the column positions that have any selected cells

      • isColumnPositionSelected

        boolean isColumnPositionSelected​(int columnPosition)
        Determines whether a specified column contains any selected cell
        Parameters:
        columnPosition - column position to inspect
        Returns:
        whether the specified column contains any selected cell

      • getFullySelectedColumnPositions

        int[] getFullySelectedColumnPositions​(int columnHeight)
        Parameters:
        columnHeight - the number of rows in a fully selected column

      • isColumnPositionFullySelected

        boolean isColumnPositionFullySelected​(int columnPosition,
                                      int columnHeight)
        Parameters:
        columnHeight - the number of rows in a fully selected column

      • getSelectedRowCount

        int getSelectedRowCount()
        Retrieves the number of rows that have any selected cell
        Returns:
        the number of rows that have any selected cell

      • getSelectedRowPositions

        Set<Range> getSelectedRowPositions()
        Retrieves the rows with a valid row position that have any selected cells
        Returns:
        the row positions with a valid row position that have any selected cells

      • isRowPositionSelected

        boolean isRowPositionSelected​(int rowPosition)
        Determines whether a specified row contains any selected cell
        Parameters:
        rowPosition - row position to inspect
        Returns:
        whether the specified row contains any selected cell

      • getFullySelectedRowPositions

        int[] getFullySelectedRowPositions​(int rowWidth)
        Parameters:
        rowWidth - the number of columns in a fully selected row

      • isRowPositionFullySelected

        boolean isRowPositionFullySelected​(int rowPosition,
                                   int rowWidth)
        Check if all cells in a row are selected, which means the row is fully selected.
        Parameters:
        rowPosition - The row position that should be checked.
        rowWidth - The number of columns in the row which is needed to determine if the all cells in a row are selected.
        Returns:
        true if all cells in a row are selected, false if not