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

Class BaseGridData

java.lang.Object

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

All Implemented Interfaces:

GridData

public class BaseGridData
extends Object
implements GridData

Base implementation of a grid to avoid boiler-plate for more specific implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface org.uberfire.ext.wires.core.grids.client.model.GridData

GridData.Range, GridData.SelectedCell

Field Summary

Fields

Modifier and Type	Field and Description
protected List<GridColumn<?>>	columns
protected int	headerRowCount
protected BaseGridDataIndexManager	indexManager
protected boolean	isColumnDraggingEnabled
protected boolean	isMerged
protected boolean	isRowDraggingEnabled
protected List<GridRow>	rows
protected List<GridData.SelectedCell>	selectedCells
protected List<GridData.SelectedCell>	selectedHeaderCells
protected BaseGridDataSelectionsManager	selectionsManager

Constructor Summary

Constructors

Constructor and Description
BaseGridData()
BaseGridData(boolean isMerged)

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.
protected GridData.Range	doSetCell(int rowIndex, int columnIndex, Function<Map.Entry<Integer,Integer>,GridCell<?>> cellSupplier)
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
protected double	getWidth()
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.
protected boolean	internalRefreshWidth(boolean changedNumberOfColumn, OptionalDouble optionalCurrentWidth)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isMerged

protected boolean isMerged

isRowDraggingEnabled

protected boolean isRowDraggingEnabled

isColumnDraggingEnabled

protected boolean isColumnDraggingEnabled

rows

protected List<GridRow> rows

columns

protected List<GridColumn<?>> columns

selectedCells

protected List<GridData.SelectedCell> selectedCells

selectedHeaderCells

protected List<GridData.SelectedCell> selectedHeaderCells

headerRowCount

protected int headerRowCount

indexManager

protected BaseGridDataIndexManager indexManager

selectionsManager

protected BaseGridDataSelectionsManager selectionsManager

Constructor Detail

BaseGridData

public BaseGridData()

BaseGridData

public BaseGridData(boolean isMerged)

Method Detail

getColumns

public List<GridColumn<?>> getColumns()

Description copied from interface: GridData

Returns the columns associated with the grid.

Specified by:

getColumns in interface GridData

Returns:

getColumnCount

public int getColumnCount()

Description copied from interface: GridData

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

Specified by:

getColumnCount in interface GridData

Returns:

appendColumn

public void appendColumn(GridColumn<?> column)

Description copied from interface: GridData

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

Specified by:

appendColumn in interface GridData

insertColumn

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

Description copied from interface: GridData

Inserts a column to the grid at the specified index.

Specified by:

insertColumn in interface GridData

deleteColumn

public void deleteColumn(GridColumn<?> column)

Description copied from interface: GridData

Deletes a column from the grid.

Specified by:

deleteColumn in interface GridData

moveColumnTo

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

Description copied from interface: GridData

Moves a column to a new index within the grid

Specified by:

moveColumnTo in interface GridData

moveColumnsTo

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

Description copied from interface: GridData

Moves columns to a new index within the grid

Specified by:

moveColumnsTo in interface GridData

getRows

public List<GridRow> getRows()

Description copied from interface: GridData

Returns the rows associated with the grid.

Specified by:

getRows in interface GridData

Returns:

getRow

public GridRow getRow(int rowIndex)

Description copied from interface: GridData

Returns the row at the specified index.

Specified by:

getRow in interface GridData

Returns:

appendRow

public void appendRow(GridRow row)

Description copied from interface: GridData

Appends a row to the end of the grid.

Specified by:

appendRow in interface GridData

insertRow

public void insertRow(int rowIndex,
                      GridRow row)

Description copied from interface: GridData

Inserts a row to the grid at the specified index.

Specified by:

insertRow in interface GridData

deleteRow

public GridData.Range deleteRow(int rowIndex)

Description copied from interface: GridData

Deletes a row from the grid at the specified index.

Specified by:

deleteRow in interface GridData

Returns:

The Range of rows affected by the operation.

moveRowTo

public void moveRowTo(int index,
                      GridRow row)

Description copied from interface: GridData

Moves a row to a new index within the grid

Specified by:

moveRowTo in interface GridData

moveRowsTo

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

Description copied from interface: GridData

Moves rowss to a new index within the grid

Specified by:

moveRowsTo in interface GridData

getRowCount

public int getRowCount()

Description copied from interface: GridData

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

Specified by:

getRowCount in interface GridData

Returns:

getHeaderRowCount

public int getHeaderRowCount()

Description copied from interface: GridData

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

Specified by:

getHeaderRowCount in interface GridData

Returns:

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

setHeaderRowCount

public void setHeaderRowCount(int headerRowCount)

Description copied from interface: GridData

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

Specified by:

setHeaderRowCount in interface GridData

Parameters:

headerRowCount - Cannot be less than 1.

getCell

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

Description copied from interface: GridData

Returns a cell at the specified physical coordinate.

Specified by:

getCell in interface GridData

Returns:

getSelectedCellsOrigin

public GridData.SelectedCell getSelectedCellsOrigin()

Description copied from interface: GridData

Returns the origin of a selected range.

Specified by:

getSelectedCellsOrigin in interface GridData

Returns:

null if no origin has been defined.

getSelectedCells

public List<GridData.SelectedCell> getSelectedCells()

Description copied from interface: GridData

Returns all selected cells.

Specified by:

getSelectedCells in interface GridData

Returns:

getSelectedHeaderCells

public List<GridData.SelectedCell> getSelectedHeaderCells()

Description copied from interface: GridData

Returns all selected header cells.

Specified by:

getSelectedHeaderCells in interface GridData

Returns:

clearSelections

public void clearSelections()

Description copied from interface: GridData

Clears all cell selections.

Specified by:

clearSelections in interface GridData

updateColumn

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

Description copied from interface: GridData

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

Specified by:

updateColumn in interface GridData

isMerged

public boolean isMerged()

Description copied from interface: GridData

Returns whether the data in a merged state.

Specified by:

isMerged in interface GridData

Returns:

true if merged.

setMerged

public void setMerged(boolean isMerged)

Description copied from interface: GridData

Sets whether the data is in merged state.

Specified by:

setMerged in interface GridData

isRowDraggingEnabled

public boolean isRowDraggingEnabled()

Description copied from interface: GridData

Returns whether rows can be repositioned by dragging and dropping.

Specified by:

isRowDraggingEnabled in interface GridData

Returns:

true if drag and drop is enabled.

setRowDraggingEnabled

public void setRowDraggingEnabled(boolean enabled)

Description copied from interface: GridData

Set whether rows can be repositioned by dragging and dropping.

Specified by:

setRowDraggingEnabled in interface GridData

Parameters:

enabled - true if drag and drop is enabled.

isColumnDraggingEnabled

public boolean isColumnDraggingEnabled()

Description copied from interface: GridData

Returns whether columns can be repositioned by dragging and dropping.

Specified by:

isColumnDraggingEnabled in interface GridData

Returns:

true if drag and drop is enabled.

setColumnDraggingEnabled

public void setColumnDraggingEnabled(boolean enabled)

Description copied from interface: GridData

Sets whether columns can be repositioned by dragging and dropping.

Specified by:

setColumnDraggingEnabled in interface GridData

Parameters:

enabled - true if drag and drop is enabled.

setCell

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

Description copied from interface: GridData

Sets a cell at the specified physical coordinate.

Specified by:

setCell in interface GridData

cellSupplier - A supplier of new cell instances

Returns:

The Range of rows affected by the operation.

setCellValue

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

Description copied from interface: GridData

Sets a cell value at the specified physical coordinate.

Specified by:

setCellValue in interface GridData

Returns:

The Range of rows affected by the operation.

doSetCell

protected GridData.Range doSetCell(int rowIndex,
                                   int columnIndex,
                                   Function<Map.Entry<Integer,Integer>,GridCell<?>> cellSupplier)

deleteCell

public GridData.Range deleteCell(int rowIndex,
                                 int columnIndex)

Description copied from interface: GridData

Deletes a cell at the specified physical coordinate.

Specified by:

deleteCell in interface GridData

Returns:

The Range of rows affected by the operation.

selectCell

public GridData.Range selectCell(int rowIndex,
                                 int columnIndex)

Description copied from interface: GridData

Selects a cell at the specified physical coordinate.

Specified by:

selectCell in interface GridData

Returns:

The Range of rows affected by the operation.

selectCells

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

Description copied from interface: GridData

Selects a cell at the specified physical coordinate.

Specified by:

selectCells in interface GridData

Returns:

The Range of rows affected by the operation.

selectHeaderCell

public GridData.Range selectHeaderCell(int headerRowIndex,
                                       int headerColumnIndex)

Description copied from interface: GridData

Selects a header cell at the specified physical coordinate.

Specified by:

selectHeaderCell in interface GridData

Returns:

The Range of rows affected by the operation.

collapseCell

public void collapseCell(int rowIndex,
                         int columnIndex)

Description copied from interface: GridData

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.

Specified by:

collapseCell in interface GridData

expandCell

public void expandCell(int rowIndex,
                       int columnIndex)

Description copied from interface: GridData

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.

Specified by:

expandCell in interface GridData

refreshWidth

public boolean refreshWidth()

Description copied from interface: GridData

Updates the width of columns with GridColumn.ColumnWidthMode.AUTO

Specified by:

refreshWidth in interface GridData

Returns:

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

refreshWidth

public boolean refreshWidth(double currentWidth)

Description copied from interface: GridData

Updates the width of columns with GridColumn.ColumnWidthMode.AUTO

Specified by:

refreshWidth in interface GridData

Parameters:

currentWidth - is the grid width before this resize iteration

Returns:

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

internalRefreshWidth

protected boolean internalRefreshWidth(boolean changedNumberOfColumn,
                                       OptionalDouble optionalCurrentWidth)

getWidth

protected double getWidth()

setVisibleSizeAndRefresh

public boolean setVisibleSizeAndRefresh(int width,
                                        int height)

Description copied from interface: GridData

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

Specified by:

setVisibleSizeAndRefresh in interface GridData

Returns:

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

getVisibleWidth

public int getVisibleWidth()

Description copied from interface: GridData

Get visible width

Specified by:

getVisibleWidth in interface GridData

Returns:

getVisibleHeight

public int getVisibleHeight()

Description copied from interface: GridData

Get visible height

Specified by:

getVisibleHeight in interface GridData

Returns: