org.uberfire.ext.wires.core.grids.client.model

Interface GridData

All Known Implementing Classes:

BaseGridData

public interface GridData

An interface defining a generic grid of data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GridData.Range A range of rows.
static class	GridData.SelectedCell A selected cell within the data.

Method Summary

Modifier and Type	Method and Description
void	appendColumn(GridColumn<?> column) Appends a column to the end of the grid.
void	appendRow(GridRow row) Appends a row to the end of the grid.
void	clearSelections() Clears all cell selections.
void	collapseCell(int rowIndex, int columnIndex) Collapses a cell and corresponding rows.
GridData.Range	deleteCell(int rowIndex, int columnIndex) Deletes a cell at the specified physical coordinate.
void	deleteColumn(GridColumn<?> column) Deletes a column from the grid.
GridData.Range	deleteRow(int rowIndex) Deletes a row from the grid at the specified index.
void	expandCell(int rowIndex, int columnIndex) Expands a cell and corresponding rows.
GridCell<?>	getCell(int rowIndex, int columnIndex) Returns a cell at the specified physical coordinate.
int	getColumnCount() Returns the total number of columns in the grid, including hidden columns.
List<GridColumn<?>>	getColumns() Returns the columns associated with the grid.
int	getHeaderRowCount() Returns the number of rows in the grid's header.
GridRow	getRow(int rowIndex) Returns the row at the specified index.
int	getRowCount() Returns the total number of rows in the grid, including collapsed rows.
List<GridRow>	getRows() Returns the rows associated with the grid.
List<GridData.SelectedCell>	getSelectedCells() Returns all selected cells.
GridData.SelectedCell	getSelectedCellsOrigin() Returns the origin of a selected range.
List<GridData.SelectedCell>	getSelectedHeaderCells() Returns all selected header cells.
int	getVisibleHeight() Get visible height
int	getVisibleWidth() Get visible width
void	insertColumn(int index, GridColumn<?> column) Inserts a column to the grid at the specified index.
void	insertRow(int rowIndex, GridRow row) Inserts a row to the grid at the specified index.
boolean	isColumnDraggingEnabled() Returns whether columns can be repositioned by dragging and dropping.
boolean	isMerged() Returns whether the data in a merged state.
boolean	isRowDraggingEnabled() Returns whether rows can be repositioned by dragging and dropping.
void	moveColumnsTo(int index, List<GridColumn<?>> columns) Moves columns to a new index within the grid
void	moveColumnTo(int index, GridColumn<?> column) Moves a column to a new index within the grid
void	moveRowsTo(int index, List<GridRow> rows) Moves rowss to a new index within the grid
void	moveRowTo(int index, GridRow row) Moves a row to a new index within the grid
boolean	refreshWidth() Updates the width of columns with GridColumn.ColumnWidthMode.AUTO
boolean	refreshWidth(double currentWidth) Updates the width of columns with GridColumn.ColumnWidthMode.AUTO
GridData.Range	selectCell(int rowIndex, int columnIndex) Selects a cell at the specified physical coordinate.
GridData.Range	selectCells(int rowIndex, int columnIndex, int width, int height) Selects a cell at the specified physical coordinate.
GridData.Range	selectHeaderCell(int headerRowIndex, int headerColumnIndex) Selects a header cell at the specified physical coordinate.
GridData.Range	setCell(int rowIndex, int columnIndex, Supplier<GridCell<?>> cellSupplier) Sets a cell at the specified physical coordinate.
GridData.Range	setCellValue(int rowIndex, int columnIndex, GridCellValue<?> value) Sets a cell value at the specified physical coordinate.
void	setColumnDraggingEnabled(boolean enabled) Sets whether columns can be repositioned by dragging and dropping.
void	setHeaderRowCount(int headerRowCount) Sets the number of rows in the grid's header.
void	setMerged(boolean isMerged) Sets whether the data is in merged state.
void	setRowDraggingEnabled(boolean enabled) Set whether rows can be repositioned by dragging and dropping.
boolean	setVisibleSizeAndRefresh(int width, int height) Update visible size information and refresh columns width.
void	updateColumn(int index, GridColumn<?> column) Updates a column in the grid at the specified index.

Method Detail

getColumns

List<GridColumn<?>> getColumns()

Returns the columns associated with the grid.

Returns:

getColumnCount

int getColumnCount()

Returns the total number of columns in the grid, including hidden columns.

Returns:

appendColumn

void appendColumn(GridColumn<?> column)

Appends a column to the end of the grid. End being considered the far most right.

Parameters:

column -

insertColumn

void insertColumn(int index,
                  GridColumn<?> column)

Inserts a column to the grid at the specified index.

Parameters:

index -

column -

updateColumn

void updateColumn(int index,
                  GridColumn<?> column)

Updates a column in the grid at the specified index. All existing row data will be cleared.

Parameters:

index -

column -

deleteColumn

void deleteColumn(GridColumn<?> column)

Deletes a column from the grid.

Parameters:

column -

moveColumnTo

void moveColumnTo(int index,
                  GridColumn<?> column)

Moves a column to a new index within the grid

Parameters:

index -

column -

moveColumnsTo

void moveColumnsTo(int index,
                   List<GridColumn<?>> columns)

Moves columns to a new index within the grid

Parameters:

index -

columns -

getRows

List<GridRow> getRows()

Returns the rows associated with the grid.

Returns:

getRow

GridRow getRow(int rowIndex)

Returns the row at the specified index.

Parameters:

rowIndex -

Returns:

appendRow

void appendRow(GridRow row)

Appends a row to the end of the grid.

Parameters:

row -

insertRow

void insertRow(int rowIndex,
               GridRow row)

Inserts a row to the grid at the specified index.

Parameters:

rowIndex -

row -

deleteRow

GridData.Range deleteRow(int rowIndex)

Deletes a row from the grid at the specified index.

Parameters:

rowIndex -

Returns:

The Range of rows affected by the operation.

moveRowTo

void moveRowTo(int index,
               GridRow row)

Moves a row to a new index within the grid

Parameters:

index -

row -

moveRowsTo

void moveRowsTo(int index,
                List<GridRow> rows)

Moves rowss to a new index within the grid

Parameters:

index -

rows -

getRowCount

int getRowCount()

Returns the total number of rows in the grid, including collapsed rows.

Returns:

getHeaderRowCount

int getHeaderRowCount()

Returns the number of rows in the grid's header.

Returns:

The number of rows in the header; greater than zero.

setHeaderRowCount

void setHeaderRowCount(int headerRowCount)

Sets the number of rows in the grid's header.

Parameters:

headerRowCount - Cannot be less than 1.

getCell

GridCell<?> getCell(int rowIndex,
                    int columnIndex)

Returns a cell at the specified physical coordinate.

Parameters:

rowIndex -

columnIndex -

Returns:

setCell

GridData.Range setCell(int rowIndex,
                       int columnIndex,
                       Supplier<GridCell<?>> cellSupplier)

Sets a cell at the specified physical coordinate.

Parameters:

rowIndex -

columnIndex -

cellSupplier - A supplier of new cell instances

Returns:

The Range of rows affected by the operation.

setCellValue

GridData.Range setCellValue(int rowIndex,
                            int columnIndex,
                            GridCellValue<?> value)

Sets a cell value at the specified physical coordinate.

Parameters:

rowIndex -

columnIndex -

value -

Returns:

The Range of rows affected by the operation.

deleteCell

GridData.Range deleteCell(int rowIndex,
                          int columnIndex)

Deletes a cell at the specified physical coordinate.

Parameters:

rowIndex -

columnIndex -

Returns:

The Range of rows affected by the operation.

selectCell

GridData.Range selectCell(int rowIndex,
                          int columnIndex)

Selects a cell at the specified physical coordinate.

Parameters:

rowIndex -

columnIndex -

Returns:

The Range of rows affected by the operation.

selectCells

GridData.Range selectCells(int rowIndex,
                           int columnIndex,
                           int width,
                           int height)

Selects a cell at the specified physical coordinate.

Parameters:

rowIndex -

columnIndex -

width -

height -

Returns:

The Range of rows affected by the operation.

getSelectedCellsOrigin

GridData.SelectedCell getSelectedCellsOrigin()

Returns the origin of a selected range.

Returns:

null if no origin has been defined.

getSelectedCells

List<GridData.SelectedCell> getSelectedCells()

Returns all selected cells.

Returns:

selectHeaderCell

GridData.Range selectHeaderCell(int headerRowIndex,
                                int headerColumnIndex)

Selects a header cell at the specified physical coordinate.

Parameters:

headerRowIndex -

headerColumnIndex -

Returns:

The Range of rows affected by the operation.

getSelectedHeaderCells

List<GridData.SelectedCell> getSelectedHeaderCells()

Returns all selected header cells.

Returns:

clearSelections

void clearSelections()

Clears all cell selections.

isMerged

boolean isMerged()

Returns whether the data in a merged state.

Returns:

true if merged.

setMerged

void setMerged(boolean isMerged)

Sets whether the data is in merged state.

Parameters:

isMerged -

isRowDraggingEnabled

boolean isRowDraggingEnabled()

Returns whether rows can be repositioned by dragging and dropping.

Returns:

true if drag and drop is enabled.

setRowDraggingEnabled

void setRowDraggingEnabled(boolean enabled)

Set whether rows can be repositioned by dragging and dropping.

Parameters:

enabled - true if drag and drop is enabled.

isColumnDraggingEnabled

boolean isColumnDraggingEnabled()

Returns whether columns can be repositioned by dragging and dropping.

Returns:

true if drag and drop is enabled.

setColumnDraggingEnabled

void setColumnDraggingEnabled(boolean enabled)

Sets whether columns can be repositioned by dragging and dropping.

Parameters:

enabled - true if drag and drop is enabled.

collapseCell

void collapseCell(int rowIndex,
                  int columnIndex)

Collapses a cell and corresponding rows. The cell being collapsed has all other merged cells below it collapsed into the single cell. The cell itself remains not collapsed.

Parameters:

rowIndex -

columnIndex -

expandCell

void expandCell(int rowIndex,
                int columnIndex)

Expands a cell and corresponding rows. The cell being collapsed has all other merged cells below it expanded. Expanding collapsed cells should not expand nested collapsed cells.

Parameters:

rowIndex -

columnIndex -

refreshWidth

boolean refreshWidth()

Updates the width of columns with GridColumn.ColumnWidthMode.AUTO

Returns:

a boolean that indicates if grid need to be redraw or not

refreshWidth

boolean refreshWidth(double currentWidth)

Updates the width of columns with GridColumn.ColumnWidthMode.AUTO

Parameters:

currentWidth - is the grid width before this resize iteration

Returns:

a boolean that indicates if grid need to be redraw or not

setVisibleSizeAndRefresh

boolean setVisibleSizeAndRefresh(int width,
                                 int height)

Update visible size information and refresh columns width. See refreshWidth()

Parameters:

width -

height -

Returns:

a boolean that indicates if grid need to be redraw or not

getVisibleWidth

int getVisibleWidth()

Get visible width

Returns:

getVisibleHeight

int getVisibleHeight()

Get visible height

Returns: