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

Interface GridRenderer

All Known Implementing Classes:

BaseGridRenderer

public interface GridRenderer

Definition of a render for the pluggable rendering mechanism.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GridRenderer.GridRendererContext
static interface	GridRenderer.RenderBodyGridBackgroundCommand Command to render the "background" components of the grid
static interface	GridRenderer.RenderBodyGridContentCommand Command to render the "content" components of the grid
static interface	GridRenderer.RenderBodyGridLinesCommand Command to render the "Grid lines" components of the grid body
static interface	GridRenderer.RendererBodyCommand Generic command for all body related rendering.
static interface	GridRenderer.RendererCommand Generic command to render a component of the grid
static interface	GridRenderer.RendererHeaderCommand Generic command for all header related rendering.
static interface	GridRenderer.RenderGridBoundaryCommand Command to render the "Grid boundary" components of the grid
static interface	GridRenderer.RenderHeaderBackgroundCommand Command to render the "background" components of the grid header
static interface	GridRenderer.RenderHeaderContentCommand Command to render the "content" components of the grid header
static interface	GridRenderer.RenderHeaderGridLinesCommand Command to render the "Grid lines" components of the grid header
static interface	GridRenderer.RenderSelectedCellsCommand Command to render the "Selected cells" component of the grid
static interface	GridRenderer.RenderSelectorCommand Command to render the "Selector" component of the grid

Method Summary

Modifier and Type	Method and Description
double	getHeaderHeight() Returns the height of the header built by this renderer.
double	getHeaderRowHeight() Returns the height of a single row in the header.
GridRendererTheme	getTheme() Returns the theme.
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.
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.

Method Detail

getHeaderHeight

double getHeaderHeight()

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 getHeaderRowHeight(). Header rows are always positioned adjacent to the Body.

Returns:

The height of the header.

getHeaderRowHeight

double getHeaderRowHeight()

Returns the height of a single row in the header.

Returns:

The height of a row.

getTheme

GridRendererTheme getTheme()

Returns the theme.

setTheme

void setTheme(GridRendererTheme theme)

Sets the theme.

Parameters:

theme -

renderSelector

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

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

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

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.

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".

renderHeader

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

Renders the header for the Grid.

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".

renderBody

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

Renders the body for the Grid.

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".

renderHeaderBodyDivider

GridRenderer.RendererCommand renderHeaderBodyDivider(double width)

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 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 getHeaderHeight().

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.

renderGridBoundary

GridRenderer.RendererCommand renderGridBoundary(GridBoundaryRenderContext context)

Renders a boundary around the grid.

Parameters:

context - The context of the render phase.

Returns:

A command that adds the grids "boundary".

onGroupingToggle

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.

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

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

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.

Parameters:

columnRenderingConstraint -