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 Summary

Modifier and Type	Method and Description
<E extends GridChange> void	addEventHandler(EventType<E> eventType, EventHandler<E> eventHandler) Registers an event handler to this Grid.
int	getColumnCount() Return how many columns are inside the grid.
int	getRowCount() Return how many rows are inside the grid.
double	getRowHeight(int row) Return the height of a row.
ObservableList<ObservableList<SpreadsheetCell>>	getRows() Return an ObservableList of ObservableList of SpreadsheetCell instances.
SpreadsheetView.SpanType	getSpanType(SpreadsheetView spv, int row, int column) Return the SpreadsheetView.SpanType for a given cell row/column intersection.
<E extends GridChange> void	removeEventHandler(EventType<E> eventType, EventHandler<E> eventHandler) Unregisters a previously registered event handler from this Grid.
void	setCellValue(int row, int column, Object value) Change the value situated at the intersection if possible.

Method Detail

getRowCount

int getRowCount()

Return how many rows are inside the grid.

getColumnCount

int getColumnCount()

Return how many columns are inside the grid.

getRows

ObservableList<ObservableList<SpreadsheetCell>> getRows()

Return an ObservableList of ObservableList of SpreadsheetCell instances. Refer to the Grid class javadoc for more detail.

Returns:

an ObservableList of ObservableList of SpreadsheetCell instances

setCellValue

void setCellValue(int row,
                  int column,
                  Object value)

Change 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 -

column -

value -

getSpanType

SpreadsheetView.SpanType getSpanType(SpreadsheetView spv,
                                     int row,
                                     int column)

Return the SpreadsheetView.SpanType for a given cell row/column intersection.

Parameters:

spv -

row -

column -

Returns:

the SpreadsheetView.SpanType for a given cell row/column intersection.

getRowHeight

double getRowHeight(int row)

Return the height of a row. It will first look into the Callbackprovided at the initialization. If nothing's found, default height will be taken.

Parameters:

row -

Returns:

the height of a row.

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.

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.

Parameters:

eventType - the event type from which to unregister

eventHandler - the handler to unregister

Throws:

NullPointerException - if the event type or handler is null