org.uberfire.ext.wires.core.grids.client.widget.grid.renderers.grids.impl

Class BaseGridRenderer

java.lang.Object

org.uberfire.ext.wires.core.grids.client.widget.grid.renderers.grids.impl.BaseGridRenderer

All Implemented Interfaces:

GridRenderer

public class BaseGridRenderer
extends Object
implements GridRenderer

A renderer that only renders the visible columns and rows of merged data. This implementation can render the data either in a merged state or non-merged state.

Nested Class Summary

Nested classes/interfaces inherited from interface org.uberfire.ext.wires.core.grids.client.widget.grid.renderers.grids.GridRenderer

GridRenderer.GridRendererContext, GridRenderer.RenderBodyGridBackgroundCommand, GridRenderer.RenderBodyGridContentCommand, GridRenderer.RenderBodyGridLinesCommand, GridRenderer.RendererBodyCommand, GridRenderer.RendererCommand, GridRenderer.RendererHeaderCommand, GridRenderer.RenderGridBoundaryCommand, GridRenderer.RenderHeaderBackgroundCommand, GridRenderer.RenderHeaderContentCommand, GridRenderer.RenderHeaderGridLinesCommand, GridRenderer.RenderSelectedCellsCommand, GridRenderer.RenderSelectorCommand

Field Summary

Fields

Modifier and Type	Field and Description
protected BiFunction<Boolean,GridColumn<?>,Boolean>	columnRenderingConstraint
protected GridRendererTheme	theme

Constructor Summary

Constructors

Constructor and Description
BaseGridRenderer(GridRendererTheme theme)

Method Summary

Modifier and Type	Method and Description
void	clearCellHighlight()
double	getHeaderHeight() Returns the height of the header built by this renderer.
double	getHeaderRowHeight() Returns the height of a single row in the header.
Integer	getHighlightCellColumnIndex()
Integer	getHighlightCellRowIndex()
GridRendererTheme	getTheme() Returns the theme.
void	highlightCell(int column, int row)
boolean	onGroupingToggle(double cellX, double cellY, double cellWidth, double cellHeight) Checks whether a cell-relative coordinate is "on" the hot-spot to toggle the collapsed/expanded state.
List<GridRenderer.RendererCommand>	renderBody(GridData model, GridBodyRenderContext context, BaseGridRendererHelper rendererHelper, BaseGridRendererHelper.RenderingInformation renderingInformation) Renders the body for the Grid.
GridRenderer.RendererCommand	renderGridBoundary(GridBoundaryRenderContext context) Renders a boundary around the grid.
List<GridRenderer.RendererCommand>	renderHeader(GridData model, GridHeaderRenderContext context, BaseGridRendererHelper rendererHelper, BaseGridRendererHelper.RenderingInformation renderingInformation) Renders the header for the Grid.
GridRenderer.RendererCommand	renderHeaderBodyDivider(double width) Renders a divider between Grid header and body.
GridRenderer.RendererCommand	renderSelectedCells(GridData model, GridBodyRenderContext context, BaseGridRendererHelper rendererHelper, List<GridData.SelectedCell> selectedCells, BiFunction<SelectedRange,Integer,Double> selectedCellsYOffsetStrategy, Function<SelectedRange,Double> selectedCellsHeightStrategy) Renders the selected ranges and append to the Body Group.
protected com.ait.lienzo.client.core.shape.Group	renderSelectedRange(List<GridColumn<?>> blockColumns, int minVisibleUiColumnIndex, SelectedRange selectedRange, Function<SelectedRange,Double> selectedCellsHeightStrategy)
GridRenderer.RendererCommand	renderSelector(double width, double height, BaseGridRendererHelper.RenderingInformation renderingInformation) Renders a "selector" when a grid has been selected, i.e. clicked.
void	setColumnRenderConstraint(BiFunction<Boolean,GridColumn<?>,Boolean> columnRenderingConstraint) Sets the constraint to control rendering of columns.
void	setTheme(GridRendererTheme theme) Sets the theme.

Methods inherited from class java.lang.Object

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

Field Detail

theme

protected GridRendererTheme theme

columnRenderingConstraint

protected BiFunction<Boolean,GridColumn<?>,Boolean> columnRenderingConstraint

Constructor Detail

BaseGridRenderer

public BaseGridRenderer(GridRendererTheme theme)

Method Detail

getHeaderHeight

public double getHeaderHeight()

Description copied from interface: GridRenderer

Returns the height of the header built by this renderer. The header's height may be greater than the product of the maximum number of header rows (see GridColumn.HeaderMetaData) and GridRenderer.getHeaderRowHeight(). Header rows are always positioned adjacent to the Body.

Specified by:

getHeaderHeight in interface GridRenderer

Returns:

The height of the header.

getHeaderRowHeight

public double getHeaderRowHeight()

Description copied from interface: GridRenderer

Returns the height of a single row in the header.

Specified by:

getHeaderRowHeight in interface GridRenderer

Returns:

The height of a row.

getTheme

public GridRendererTheme getTheme()

Description copied from interface: GridRenderer

Returns the theme.

Specified by:

getTheme in interface GridRenderer

setTheme

public void setTheme(GridRendererTheme theme)

Description copied from interface: GridRenderer

Sets the theme.

Specified by:

setTheme in interface GridRenderer

renderSelector

public GridRenderer.RendererCommand renderSelector(double width,
                                                   double height,
                                                   BaseGridRendererHelper.RenderingInformation renderingInformation)

Description copied from interface: GridRenderer

Renders a "selector" when a grid has been selected, i.e. clicked.

Specified by:

renderSelector in interface GridRenderer

Parameters:

width - The width of the GridWidget.

height - The height of the GridWidget including header and body.

renderingInformation - Calculated rendering information supporting rendering.

Returns:

A command that adds the "selector".

renderSelectedCells

public GridRenderer.RendererCommand renderSelectedCells(GridData model,
                                                        GridBodyRenderContext context,
                                                        BaseGridRendererHelper rendererHelper,
                                                        List<GridData.SelectedCell> selectedCells,
                                                        BiFunction<SelectedRange,Integer,Double> selectedCellsYOffsetStrategy,
                                                        Function<SelectedRange,Double> selectedCellsHeightStrategy)

Description copied from interface: GridRenderer

Renders the selected ranges and append to the Body Group.

Specified by:

renderSelectedCells in interface GridRenderer

Parameters:

model - The data model for the GridWidget.

context - The context of the render phase.

rendererHelper - Helper for rendering.

selectedCells - The cells that are selected.

selectedCellsYOffsetStrategy - A function that returns the YOffset of a selection.

selectedCellsHeightStrategy - A function that returns the height of a selection.

Returns:

A command that adds the "selected cells".

renderSelectedRange

protected com.ait.lienzo.client.core.shape.Group renderSelectedRange(List<GridColumn<?>> blockColumns,
                                                                     int minVisibleUiColumnIndex,
                                                                     SelectedRange selectedRange,
                                                                     Function<SelectedRange,Double> selectedCellsHeightStrategy)

renderHeader

public List<GridRenderer.RendererCommand> renderHeader(GridData model,
                                                       GridHeaderRenderContext context,
                                                       BaseGridRendererHelper rendererHelper,
                                                       BaseGridRendererHelper.RenderingInformation renderingInformation)

Description copied from interface: GridRenderer

Renders the header for the Grid.

Specified by:

renderHeader in interface GridRenderer

Parameters:

model - The data model for the GridWidget.

context - The context of the render phase.

rendererHelper - Helper for rendering.

renderingInformation - Calculated rendering information supporting rendering.

Returns:

Commands that add the "header".

renderHeaderBodyDivider

public GridRenderer.RendererCommand renderHeaderBodyDivider(double width)

Description copied from interface: GridRenderer

Renders a divider between Grid header and body. The divider must be positioned in the Group relative to the top-left of the Grid itself; i.e. horizontal lines will need have y-coordinate GridRenderer.getHeaderHeight(). The returned Group itself is not positioned when added to the Grid. This is to support different types of divider that may need to be positioned at a y-coordinate different to GridRenderer.getHeaderHeight().

Specified by:

renderHeaderBodyDivider in interface GridRenderer

Parameters:

width - The width of the divider. May not be the width of the whole grid if there are floating columns.

Returns:

A Group containing the divider positioned relative to the top-left of the Grid.

renderBody

public List<GridRenderer.RendererCommand> renderBody(GridData model,
                                                     GridBodyRenderContext context,
                                                     BaseGridRendererHelper rendererHelper,
                                                     BaseGridRendererHelper.RenderingInformation renderingInformation)

Description copied from interface: GridRenderer

Renders the body for the Grid.

Specified by:

renderBody in interface GridRenderer

Parameters:

model - The data model for the GridWidget.

context - The context of the render phase.

rendererHelper - Helper for rendering.

renderingInformation - Calculated rendering information supporting rendering.

Returns:

Commands that add the "body".

renderGridBoundary

public GridRenderer.RendererCommand renderGridBoundary(GridBoundaryRenderContext context)

Description copied from interface: GridRenderer

Renders a boundary around the grid.

Specified by:

renderGridBoundary in interface GridRenderer

Parameters:

context - The context of the render phase.

Returns:

A command that adds the grids "boundary".

onGroupingToggle

public boolean onGroupingToggle(double cellX,
                                double cellY,
                                double cellWidth,
                                double cellHeight)

Description copied from interface: GridRenderer

Checks whether a cell-relative coordinate is "on" the hot-spot to toggle the collapsed/expanded state.

Specified by:

onGroupingToggle in interface GridRenderer

Parameters:

cellX - The MouseEvent relative to the cell's x-coordinate.

cellY - The MouseEvent relative to the cell's y-coordinate.

cellWidth - Width of the containing cell.

cellHeight - Height of the containing cell.

Returns:

true if the cell coordinate is on the hot-spot.

setColumnRenderConstraint

public void setColumnRenderConstraint(BiFunction<Boolean,GridColumn<?>,Boolean> columnRenderingConstraint)

Description copied from interface: GridRenderer

Sets the constraint to control rendering of columns. The default implementation does not render to the SelectionLayer as a performance optimisation and only their basic definition, e.g. size, background colour, grid is rendered to support selection. Nested tables need to be rendered to the SelectionLayer to support their selection and other User interactions.

Specified by:

setColumnRenderConstraint in interface GridRenderer

clearCellHighlight

public void clearCellHighlight()

highlightCell

public void highlightCell(int column,
                          int row)

getHighlightCellColumnIndex

public Integer getHighlightCellColumnIndex()

getHighlightCellRowIndex

public Integer getHighlightCellRowIndex()