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

Interface GridRendererTheme

All Known Implementing Classes:

BlueTheme, GreenTheme, MultiColouredTheme, RedTheme

public interface GridRendererTheme

Definition of themes used by a render for the pluggable rendering mechanism.

Method Summary

Modifier and Type	Method and Description
com.ait.lienzo.client.core.shape.Rectangle	getBodyBackground(GridColumn<?> column) Delegates the Body's background Rectangle to sub-classes.
com.ait.lienzo.client.core.shape.MultiPath	getBodyGridLine() Delegates the Body's grid lines to sub-classes.
com.ait.lienzo.client.core.shape.Text	getBodyText() Delegates the Body's Text to sub-classes.
com.ait.lienzo.client.core.shape.Rectangle	getCellSelectorBackground() Delegates construction of the cell "selector" background to sub-classes.
com.ait.lienzo.client.core.shape.Rectangle	getCellSelectorBorder() Delegates construction of the cell "selector" border to sub-classes.
com.ait.lienzo.client.core.shape.Rectangle	getGridBoundary() Delegates construction of the Grids boundary to sub-classes.
com.ait.lienzo.client.core.shape.Line	getGridHeaderBodyDivider() Delegates construction of a divider between the Grids header and body to sub-classes.
com.ait.lienzo.client.core.shape.Rectangle	getHeaderBackground(GridColumn<?> column) Delegates the Header's background Rectangle to sub-classes.
com.ait.lienzo.client.core.shape.MultiPath	getHeaderGridLine() Delegates the Header's grid lines to sub-classes.
com.ait.lienzo.client.core.shape.Rectangle	getHeaderLinkBackground(GridColumn<?> column) Delegates the Header's background Rectangle, used for "linked" columns to sub-classes.
com.ait.lienzo.client.core.shape.Text	getHeaderText() Delegates the Header's Text to sub-classes.
default com.ait.lienzo.client.core.shape.Rectangle	getHighlightedCellBackground() Delegates the highlighted cell background Rectangle to sub-classes.
String	getName() Returns a display name for the theme.
default com.ait.lienzo.client.core.shape.Text	getPlaceholderText() Delegates the Body's Text to sub-classes.
com.ait.lienzo.client.core.shape.MultiPath	getSelector() Delegates construction of the "selector" to sub-classes.

Method Detail

getName

String getName()

Returns a display name for the theme.

Returns:

A name for the theme

getSelector

com.ait.lienzo.client.core.shape.MultiPath getSelector()

Delegates construction of the "selector" to sub-classes. All implementations are to provide a MultiPath to draw around the GridWidget.

Returns:

A MultiPath for the "selector"

getCellSelectorBorder

com.ait.lienzo.client.core.shape.Rectangle getCellSelectorBorder()

Delegates construction of the cell "selector" border to sub-classes.

Returns:

A Rectangle for the cell "selector"

getCellSelectorBackground

com.ait.lienzo.client.core.shape.Rectangle getCellSelectorBackground()

Delegates construction of the cell "selector" background to sub-classes.

Returns:

A Rectangle for the cell "selector"

getHeaderBackground

com.ait.lienzo.client.core.shape.Rectangle getHeaderBackground(GridColumn<?> column)

Delegates the Header's background Rectangle to sub-classes.

Parameters:

column - The column being rendered.

Returns:

A Rectangle for the header's background.

getHeaderLinkBackground

com.ait.lienzo.client.core.shape.Rectangle getHeaderLinkBackground(GridColumn<?> column)

Delegates the Header's background Rectangle, used for "linked" columns to sub-classes.

Parameters:

column - The column being rendered.

Returns:

A Rectangle for a header's background for a "linked" column.

getHeaderGridLine

com.ait.lienzo.client.core.shape.MultiPath getHeaderGridLine()

Delegates the Header's grid lines to sub-classes.

Returns:

A MultiPath to be used to render the header's grid lines.

getHeaderText

com.ait.lienzo.client.core.shape.Text getHeaderText()

Delegates the Header's Text to sub-classes.

Returns:

A Text used to render all text in the header.

getBodyBackground

com.ait.lienzo.client.core.shape.Rectangle getBodyBackground(GridColumn<?> column)

Delegates the Body's background Rectangle to sub-classes.

Parameters:

column - The column being rendered.

Returns:

A Rectangle for the body's background.

getBodyGridLine

com.ait.lienzo.client.core.shape.MultiPath getBodyGridLine()

Delegates the Body's grid lines to sub-classes.

Returns:

A MultiPath to be used to render the body's grid lines.

getBodyText

com.ait.lienzo.client.core.shape.Text getBodyText()

Delegates the Body's Text to sub-classes.

Returns:

A Text used to render all text in the body.

getGridBoundary

com.ait.lienzo.client.core.shape.Rectangle getGridBoundary()

Delegates construction of the Grids boundary to sub-classes. All implementations are to provide a Rectangle surrounding the whole GridWidget.

Returns:

A Rectangle for the Grid's boundary.

getGridHeaderBodyDivider

com.ait.lienzo.client.core.shape.Line getGridHeaderBodyDivider()

Delegates construction of a divider between the Grids header and body to sub-classes.

Returns:

A Line for the divider.

getPlaceholderText

default com.ait.lienzo.client.core.shape.Text getPlaceholderText()

Delegates the Body's Text to sub-classes.

Returns:

A Text used to render the placeholder in the body.

getHighlightedCellBackground

default com.ait.lienzo.client.core.shape.Rectangle getHighlightedCellBackground()

Delegates the highlighted cell background Rectangle to sub-classes.

Returns:

A Rectangle for the cell's highlight background.